The /payment_initiation/recipient/list endpoint list the payment recipients that you have previously created.
643 matches
46 actions
Plaid
46 actions
- Create a deposit switchPOSTv1.0.0
- Create a deposit switch without using Plaid ExchangePOSTv1.0.0
- Create a new identity verificationPOSTv1.0.0
- Create an Asset ReportPOSTv1.0.0
- Create Asset Report Audit CopyPOSTv1.0.0
- Create Link Delivery sessionPOSTv1.0.0
- Create payment consentPOSTv1.0.0
- Create payment profilePOSTv1.0.0
- Create payment recipientPOSTv1.0.0
- Creates a new end customer for a Plaid reseller.POSTv1.0.0
- Get balance of your Bank Transfer accountPOSTv1.0.0
- Get CategoriesPOSTv1.0.0
- Get details of all supported institutionsPOSTv1.0.0
- Get details of an institutionPOSTv1.0.0
- Get Link Delivery sessionPOSTv1.0.0
- Get payment consentPOSTv1.0.0
- Get payment detailsPOSTv1.0.0
- Get payment profilePOSTv1.0.0
- Get payment recipientPOSTv1.0.0
- List a historical log of user consent eventsPOSTv1.0.0
- List a user’s connected applicationsPOSTv1.0.0
- List dashboard usersPOSTv1.0.0
- List Identity VerificationsPOSTv1.0.0
- List payment recipientsPOSTv1.0.0
- List sweepsPOSTv1.0.0
- Retrieve a dashboard userPOSTv1.0.0
- Retrieve a PDF Asset ReportPOSTv1.0.0
- Retrieve a summary of an individual's employment informationPOSTv1.0.0
- Retrieve a sweepPOSTv1.0.0
- Retrieve a user's payroll informationPOSTv1.0.0
- Retrieve an Asset ReportPOSTv1.0.0
- Retrieve an Asset Report Audit CopyPOSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.POSTv1.0.0
- Retrieve an ItemPOSTv1.0.0
- Retrieve identity dataPOSTv1.0.0
- Retrieve identity match scorePOSTv1.0.0
- Retrieve Identity VerificationPOSTv1.0.0
- Retrieve information about a Plaid applicationPOSTv1.0.0
- Retrieve information from the bank accounts used for employment verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verificationPOSTv1.0.0
- Retrieve information from the bank accounts used for income verification in PDF formatPOSTv1.0.0
- Retrieve Link sessions for your userPOSTv1.0.0
- Search employer databasePOSTv1.0.0
- Search institutionsPOSTv1.0.0
- Update the scopes of access for a particular applicationPOSTv1.0.0
Finance/Plaid
List payment recipients
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
{
"type": "object",
"description": "PaymentInitiationRecipientListRequest defines the request schema for `/payment_initiation/recipient/list`",
"properties": {
"client_id": {
"type": "string",
"description": "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
},
"secret": {
"type": "string",
"description": "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
{
"type": "object",
"description": "PaymentInitiationRecipientListResponse defines the response schema for `/payment_initiation/recipient/list`",
"required": [
"recipients",
"request_id"
],
"properties": {
"recipients": {
"type": "array",
"description": "An array of payment recipients created for Payment Initiation",
"items": {
"type": "object",
"description": "PaymentInitiationRecipient defines a payment initiation recipient",
"required": [
"recipient_id",
"name"
],
"properties": {
"address": {
"type": "object",
"description": "The optional address of the payment recipient.",
"required": [
"street",
"city",
"postal_code",
"country"
],
"properties": {
"city": {
"type": "string",
"description": "The city where the recipient is located. Maximum of 35 characters."
},
"country": {
"type": "string",
"description": "The ISO 3166-1 alpha-2 country code where the recipient is located."
},
"postal_code": {
"type": "string",
"description": "The postal code where the recipient is located. Maximum of 16 characters."
},
"street": {
"type": "array",
"description": "An array of length 1-2 representing the street address where the recipient is located. Maximum of 70 characters.",
"items": {
"type": "string"
}
}
}
},
"bacs": {
"description": "An object containing a BACS account number and sort code. If an IBAN is not provided or if this recipient needs to accept domestic GBP-denominated payments, BACS data is required.",
"type": "object"
},
"iban": {
"type": "string",
"description": "The International Bank Account Number (IBAN) for the recipient."
},
"name": {
"type": "string",
"description": "The name of the recipient."
},
"recipient_id": {
"type": "string",
"description": "The ID of the recipient."
}
}
}
},
"request_id": {
"type": "string",
"description": "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
}
}
}