The following endpoints are used to manage the transfer methods.
POST /transfer-methodsGET /transfer-methods/:idGET /transfer-methodsDELETE /transfer-methods
The transfer-method
object represents a request for creating a new transfer method associated to a specific identity.
Transfer methods are identified by a unique, random id
, and relate to a user's identityId
.
{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "waiting","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}
​
{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}
​
POST [ENVIRONMENT HOSTNAME]/transfer-methods​{"identityId": "e0564926-96e0-42e2-a544-68bc18598e40","transferMethodInformation": {"transferType": "ach","plaidPublicToken": "12313123123","plaidUserAccountId": "123456789"}}
curl --location --request POST 'https://api.tst.publicmint.io/transfer-methods' \--header 'apikey: {INSERT API KEY HERE}' \--header 'Content-Type: application/json' \--data-raw '{"identityId": "971c3241-9876-471e-b0b3-40040893efd0","transferMethodInformation": {"transferType": "ach","plaidPublicToken": "123456789","plaidUserAccountId": "1231313"}}'
{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}
{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}
​
GET [ENVIRONMENT HOSTNAME]/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040
curl --location --request GET 'https://api.tst.publicmint.io/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040' \-H 'apikey: {INSERT API KEY HERE}' \
{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}
{"total": 1,"data": [{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}]}
​
GET [ENVIRONMENT HOSTNAME]/transfer-methods
curl --location --request GET 'https://api.tst.publicmint.io/transfer-methods' \-H 'apikey: {INSERT API KEY HERE}' \
{"total": 1,"data": [{"id": "dea456c8-7743-4f3a-8a34-f6a9b8650040","identityId": "e0564926-96e0-42e2-a544-68bc18598e40","status": "active","transferMethodInformation": {"transferType": "ach","routingNumber": "123456789","bankAccountName": "1231313","bankAccountNumber": "12313123123"},"createdAt": "2020-01-30T13:43:14.559Z","updatedAt": "2020-01-30T13:43:15.170Z","deletedAt": null}]}
​
​
DELETE [ENVIRONMENT HOSTNAME]/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040
curl --location --request DELETE 'https://api.tst.publicmint.io/transfer-methods/' \--header 'Content-Type: application/json' \--header 'apikey: {INSERT API KEY HERE}' \
​