Bank Account Approvals
An approved
Bank Account Approval is required for the funds in a Settlement Wallet to be released. A Media Upload is uploaded by the user to provide evidence of ownership of the Bank Account to be approved.
Contents
Models
Bank Account Approval
Mandatory Fields
Field | Type | Description |
---|---|---|
id | String | The Bank Account Approval’s unique identifier. |
bankAccountId | String | The id of the associated Bank Account. |
mediaUploadId | String | The id of the associated Media Upload. |
accountId | String | The id of the owning Centrapay Account. |
type | String | The type of Bank Account Approval. |
status | String | The current status of the Bank Account Approval. Supported values are created , pending , approved , declined and done . |
createdAt | Timestamp | When the Bank Account Approval was created. |
createdBy | CRN | The User or API Key that created the Bank Account Approval. |
modifiedAt | Timestamp | When the Bank Account Approval was updated. |
modifiedBy | CRN | The User or API Key that updated the Bank Account Approval. |
approvalActivities | Array | An array of Bank Account Approval Activity associated with the Bank Account Approval. |
Bank Account Approval Activity
Mandatory Fields
Field | Type | Description |
---|---|---|
activityNumber | Number | Unique sequential Bank Account Approval Activity number. |
approvalId | String | The id of the associated Bank Account Approval. |
activityType | String | The type of the Bank Account Approval Activity. |
createdAt | Timestamp | When the Bank Account Approval Activity was created. |
createdBy | CRN | The User or API Key that created the Bank Account Approval Activity. |
Operations
Request Bank Account Approval EXPERIMENTAL
POST /
curl -X POST https://service.centrapay.com/api/bank-account-approvals \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"mediaUploadId": "uooxSens6ykJaim1Cu1Q55",
"bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY"
}'
Required Fields
Field | Type | Description |
---|---|---|
mediaUploadId | String | The id of the associated Media Upload. |
bankAccountId | String | The id of the associated Bank Account. |
Example response payload
{
"id": "DcTs3U38HdhfEqwF1GKoT3",
"mediaUploadId": "uooxSens6ykJaim1Cu1Q55",
"bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"type": "settlement",
"status": "created",
"createdAt": "2021-11-08T21:52:39.915Z",
"createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"modifiedAt": "2021-11-08T21:52:39.915Z",
"modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
Get Bank Account Approval EXPERIMENTAL
POST /
curl -X POST https://service.centrapay.com/api/bank-account-approvals/DcTs3U38HdhfEqwF1GKoT3 \
-H "X-Api-Key: $api_key"
Example response payload
{
"id": "DcTs3U38HdhfEqwF1GKoT3",
"mediaUploadId": "uooxSens6ykJaim1Cu1Q55",
"bankAccountId": "WRhAxxWpTKb5U7pXyxQjjY",
"accountId": "Jaim1Cu1Q55uooxSens6yk",
"type": "settlement",
"status": "pending",
"createdAt": "2021-11-08T21:52:39.915Z",
"createdBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey",
"modifiedAt": "2021-11-08T21:52:39.915Z",
"modifiedBy": "crn:WIj211vFs9cNACwBb04vQw:api-key:MyApiKey"
}
Accept a Bank Account Approval EXPERIMENTAL
POST /
curl -X POST https://service.centrapay.com/api/bank-account-approvals/DcTs3U38HdhfEqwF1GKoT3/accept \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"reason": "All details match"
}'
Optional Fields
Field | Type | Description |
---|---|---|
reason | String | The reason for accepting the Bank Account Approval. |
Example response payload
{
}
Error Responses
Status | Code | Description |
---|---|---|
403 | APPROVAL_ALREADY_REVIEWED | The Bank Account Approval has already been accepted or declined. |
Decline a Bank Account Approval EXPERIMENTAL
POST /
curl -X POST https://service.centrapay.com/api/bank-account-approvals/DcTs3U38HdhfEqwF1GKoT3/decline \
-H "X-Api-Key: $api_key" \
-H "Content-Type: application/json" \
-d '{
"reason": "All details match"
}'
Required Fields
Field | Type | Description |
---|---|---|
reason | String | The reason for declining the Bank Account Approval. |
Example response payload
{
}
Error Responses
Status | Code | Description |
---|---|---|
403 | APPROVAL_ALREADY_REVIEWED | The Bank Account Approval has already been accepted or declined. |