Transfer Methods
The following endpoints are use to manage and retrieve the transfer methods on the system.
DELETE /transfer-methods/:id
GET /transfer-methods/:id
GET /transfer-methods
POST /transfer-methods
Introduction
This API provides transfer method management functionalities.
Transfer methods
Transfer method entity model
Name | Type | Description | Constraints |
---|---|---|---|
appId |
| Application ID. Format: | |
createdAt |
| Transfer method created at date. |
|
deletedAt |
| Transfer method deleted at date. | |
externalReference |
| Transfer method external reference. | |
id |
| Transfer method identifier. Format: |
|
identityId |
| Transfer method identity owner. Format: | |
metadata |
| Transfer method metadata. | |
type |
| Transfer method type. | Enum:[ |
updatedAt |
| Transfer method updated at date. |
|
Remove a transfer method
DELETE /transfer-methods/:id
Delete transfer method by id.
Response Options
400 Bad Request
validation_failed
If id is invalid.
404 Not Found
transfer_method_not_found
204 OK
Request example:
Get a transfer method
GET /transfer-methods/:id
Get transfer method by id.
Response Options
400 Bad Request
validation_failed
If id is invalid.
404 Not Found
transfer_method_not_found
200 OK
Request example:
Response example:
Get all transfer methods
GET /transfer-methods
Get transfer methods list.
Available filters
Name | Type | Example |
---|---|---|
externalReference |
|
|
id |
|
|
identityId |
|
|
type |
|
|
Available sorts
Name | Example |
---|---|
createdAt |
|
updatedAt |
|
Paginate options
Name | Description | Example |
---|---|---|
size | Defines the number of results per page. Default = 30. |
|
number | Defines the number of the page to retrieve. Default = 1 |
|
all | Return all identities without pagination |
|
Response Options
200 OK
Request example:
Response example:
Create a new transfer method
POST /transfer-methods
Creates a transfer method.
Request Parameters
Body parameters for type internationalWire
Name | Type | Description | Constraints | Required |
---|---|---|---|---|
bankAccountName |
| Bank account name amount. |
|
|
bankAccountNumber |
| Bank account number. | Valid IBAN |
|
bankName |
| Bank name. |
|
|
identityId |
| Identity identification. Format: |
| |
swiftCode |
| Swift code. | Valid swift code. |
|
type |
| Transfer method. |
|
|
Body parameters for type wire
Name | Type | Description | Constraints | Required |
---|---|---|---|---|
bankAccountName |
| Bank account name amount. |
|
|
bankAccountNumber |
| Bank account number. | Valid US acccount number |
|
identityId |
| Identity identification. Format: |
| |
routingNumber |
| Routing number. | Valid routing number. |
|
type |
| Transfer method. |
|
|
Body parameters for type ach
Name | Type | Description | Constraints | Required |
---|---|---|---|---|
plaidAccessToken |
| Plaid access token. |
|
|
plaidAccountId |
| Plaid account id. |
|
|
identityId |
| Identity identification. Format: |
| |
type |
| Transfer method. |
|
|
Body parameters for type pix
Name | Type | Description | Constraints | Required |
---|---|---|---|---|
document |
| Document id. |
|
|
identityId |
| Identity identification. Format: |
| |
type |
| Transfer method. |
|
|
Response Options
400 Bad Request
validation_failed
If the required parameters are not provided.
If additional parameters are provided.
If some of the parameters type is invalid.
If some of the parameters constraints is not respected.
200 OK
Request example:
Response example:
Last updated