Start
Introduction
Core Concepts
Partner setup
Tutorials [WIP]
Public Mint Widget
Getting started
Embed Widget
Public Mint API
Getting started
Creating identities
Connecting to the blockchain
Executing Transactions
Sandbox
API Reference
Transfer Methods
Withdrawals
Verifications
Identity Relations
Identities
Documents
Deposits
Authentication
Pagination
Errors
Core Resources
Public Mint Blockchain
Getting started
Transacting
Interoperability [WIP]
Other Information
Public Mint Wallet
Users and Accounts
Powered by GitBook

Transfer Methods

The following endpoints are used to manage the transfer methods.

TRANSFER METHODS ENDPOINTS
TRANSFER METHODS ENDPOINTS
POST /transfer-methods
GET /transfer-methods/:id
GET /transfer-methods
DELETE /transfer-methods

The transfer-method object

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.

TRANSFER METHOD OBJECT
TRANSFER METHOD OBJECT
{
    "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
}

​

post
POST /transfer-methods

[ENVIRONMENT HOSTNAME]/transfer-methods
This endpoint allows the creation of a new transfer method.
Request
Response
Request
Body Parameters
transferMethodInformation
required
object
Object containing the information of the transfer method
identityId
required
string
Id of the identity
Response
200: OK
{
    "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
}

​

Example Call

Request
CURL
Response
Request
POST [ENVIRONMENT HOSTNAME]/transfer-methods
​
{
	"identityId": "e0564926-96e0-42e2-a544-68bc18598e40",
	"transferMethodInformation": {
		"transferType": "ach",
		"plaidPublicToken":  "12313123123",
		"plaidUserAccountId":  "123456789" 
	}
}
CURL
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" 
	}
}'
Response
{
    "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
GET /transfer-methods/:id

[ENVIRONMENT HOSTNAME]/transfer-methods/:id
Request
Response
Request
Path Parameters
id
required
string
Id of the transfer method
Response
200: OK
{
    "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
}

​

Example Call

Request
CURL
Response
Request
GET [ENVIRONMENT HOSTNAME]/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040
CURL
curl --location --request GET 'https://api.tst.publicmint.io/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040' \
-H 'apikey: {INSERT API KEY HERE}' \
Response
{
    "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
GET /transfer-methods/

[ENVIRONMENT HOSTNAME]/transfer-methods
This endpoint returns a paginated all the transfer methods owned by you.
Request
Response
Request
Path Parameters
optional
string
​
Response
200: OK
{
    "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
    }]
}

​

Example Call

Request
CURL
Response
Request
GET [ENVIRONMENT HOSTNAME]/transfer-methods
CURL
curl --location --request GET 'https://api.tst.publicmint.io/transfer-methods' \
-H 'apikey: {INSERT API KEY HERE}' \
Response
{
    "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
DELETE /transfer-methods/:id

[ENVIRONMENT HOSTNAME]/transfer-methods/:id
Request
Response
Request
Path Parameters
id
required
string
Transfer method id to be deleted
Response
204: No Content
​

​

Example Call

Request
CURL
Response
Request
DELETE [ENVIRONMENT HOSTNAME]/transfer-methods/dea456c8-7743-4f3a-8a34-f6a9b8650040
CURL
curl --location --request DELETE 'https://api.tst.publicmint.io/transfer-methods/' \
--header 'Content-Type: application/json' \
--header 'apikey: {INSERT API KEY HERE}' \
Response
​
Public Mint API - Previous
API Reference
Next
Withdrawals
Last updated 3 weeks ago
Contents
The transfer-method object
post
POST /transfer-methods
get
GET /transfer-methods/:id
get
GET /transfer-methods/
delete
DELETE /transfer-methods/:id