Use Cases
This API supports functionality to retrieve single/multiple recipient(s), create a new recipient, update existing recipient and delete existing recipient.
The user in this case is the customer of the financial institution.
Retrieves a list of recipients
Get list of all recipients GET /db-recipients/v1/recipients
Request:
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
Retrieves a recipient
Get the recipient by recipientId GET /db-recipients/v1/recipients/{recipientId}
Request:
-
Path Variables:
- recipientId: A string, an ID of the recipient to be retrieved
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
Creates/validates a recipient
Creates a recipient POST /db-recipients/v1/recipients
Request:
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
-
Query Parameters:
- validate: True/False, used for validation a recipient. False or no value means create recipient
- fromAccountId: A string, account ID of the sender
-
Body
- memberNumber: Unique recipient member number
- accountNumber: Unique recipient account number
- accountType: Recipient account type
- passCode: Recipient passcode
- nickName: Recipient nick name
Sample Body for GENERIC provider type:
{
"memberNumber": "testrecipient48",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"nickName": "las passcode"
}
Sample Body for NONGENERIC provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Sample Body for PHOENIX provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"accountNumber": "0000",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Updates an existing recipient
Change an existing recipient PUT /db-recipients/v1/recipients/{recipientId}
Request:
-
Path Variables:
- recipientId: A string, an ID of the recipient to be retrieved
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
-
Query Parameters:
- fromAccountId: A string, account ID of the sender
-
Body
- id: Recipient ID
- memberNumber: Unique recipient member number
- accountNumber: Unique recipient account number
- accountType: Recipient account type
- passCode: Recipient passcode
- nickName: Recipient nick name. This field is required.
- email: Recipient email. This field is required
Sample Body for GENERIC provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"memberNumber": "testrecipient48",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "[someone@email.com](mailto:someone@email.com)",
"nickName": "las passcode"
}
Sample Body for PHOENIX provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Sample Body for NONGENERIC provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"accountNumber": "0000",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Deletes an existing recipient
Deletes a recipient DELETE*/db-recipients/v1/recipients/{recipientId}*
Request:
-
Path Variables:
- recipientId: A string, an ID of the recipient to be retrieved
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- callingAppId: An ID of the application that made this request
-
Body
Creates a transfer
Create a transfer (applies to both Instant and SRT) POST*/db-transfers/v1/transfers*
Request:
-
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
-
Body
- fromAccountHolderId: This is the institution customer ID of the entity that holds the from account. The entity may be a member or a business location. In the case of institution owned account transfers, this may be null if the transfer is being made from an institution owned account.
- fromAccountId: The account ID number of the account being debited
- toAccountHolderId: This is the institution customer ID or recipient id (for recipients) of the entity that holds the to account. This entity may be a member, a business location, or a recipient. In the case of institution owned account transfers, this may be null if the transfer is being made to an institution owned account.
- toAccountId: The account ID of the account being credited
- amount: The amount of the transfer
Sample Body:
{
"fromAccountHolderId": "2b4228c0da3711e4b306005056a0441b",
"fromAccountId": "SXTBuDFwBlRU-6emvp6UzmXN64IR8u8aypa-wSOGDgg",
"toAccountId": "d3XlGnYR06hizNVfcOMORXBHqDm6MZZP2-NUwGsgMpk",
"amount": {
"amount": 1
}
}
Example Code
Here’s an excerpt from the money movement service:
- Retrieves a list of recipients
Sample Response:
{
"Recipients": [
{
"id": "0139e99d544f4ec39e1681cbf8c682e8",
"institutionId": "02122",
"memberNumber": "RECIPIENT09",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "1234569170",
"accountType": "UNKNOWN",
"passCode": "FER",
"email": "x@[example.com](http://example.com)",
"nickName": "Ch ! @ # $ % ^ & \* ( ) - . ; : ,"
},
{
"id": "ba1a4209d04d4aa689ec8e0f57ecf034",
"institutionId": "02122",
"memberNumber": "RECIPIENT05",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "1234569130",
"accountType": "CHECKING",
"passCode": "A",
"email": "other.email-with-hyphen@[example.com](http://example.com)",
"nickName": "One letter passcode"
},
]
}
Retrieves a recipient
Sample Response:
{
"id": "ba1a4209d04d4aa689ec8e0f57ecf034",
"institutionId": "02122",
"memberNumber": "RECIPIENT05",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "1234569130",
"accountType": "CHECKING",
"passCode": "A",
"email": "other.email-with-hyphen@[example.com](http://example.com)",
"nickName": "One letter passcode"
}
Creates/validates a recipient
Sample Response for GENERIC provider type:
{
"id": "7109b05c948244798ccd93da69d4f1eb",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"memberNumber": "testrecipient48",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"nickName": "las passcode"
}
Sample Response for NONGENERIC provider type:
{
"id": "7109b05c948244798ccd93da69d4f1eb",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "0000",
"passCode": "LAS",
"nickName": "las passcode"
}
Sample Response for PHOENIX provider type
{
"id": "7109b05c948244798ccd93da69d4f1eb",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"nickName": "las passcode"
}
Updates an existing recipient
Sample Response for GENERIC provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"memberNumber": "testrecipient48",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Sample Response for NONGENERIC provider type:
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"memberNumber": "testrecipient48",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Sample Response for PHOENIX provider type
{
"id": "914f7ce575bb4c22aa8aaaa5c50a5377",
"institutionId": "02122",
"institutionCustomerId": "a1fb5e6d2bf1491a9e22f59f7238d00a",
"accountNumber": "0000",
"accountType": "SAVINGS",
"passCode": "LAS",
"email": "someone@[email.com](http://email.com)",
"nickName": "las passcode"
}
Deletes an existing recipient
Response:
Returns 204 for successful response without content
Creates a transfer
Sample Response:
{
"fromAccountHolderId": "2b4228c0da3711e4b306005056a0441b",
"fromAccountId": "SXTBuDFwBlRU-6emvp6UzmXN64IR8u8aypa-wSOGDgg",
"toAccountId": "d3XlGnYR06hizNVfcOMORXBHqDm6MZZP2-NUwGsgMpk",
"amount": {
"amount": 1
},
"status": "SUCCESS",
"confirmation": "(Test Post): Hey RegE! # 61319",
"fee": {
"amount": 4.5
}
}
