Query Batch Status

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v4/payees/batch/{batchId}

Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v4/payees/batch/'

Response Example

200 - Example 1

{
    "failureCount": 2,
    "failures": [
        {
            "failedSubmission": {
                "address": {
                    "city": "Key West",
                    "country": "US",
                    "countyOrProvince": "FL",
                    "line1": "500 Duval St",
                    "line2": "line2",
                    "line3": "line3",
                    "line4": "line4",
                    "zipOrPostcode": "33945"
                },
                "challenge": {
                    "description": "challenge description",
                    "value": "challenge test"
                },
                "company": {
                    "name": "ABC Group Plc",
                    "operatingName": "ABC Co",
                    "taxId": "123123123"
                },
                "email": "bob@example.com",
                "individual": {
                    "dateOfBirth": "1970-05-20T00:00:00.000+0000",
                    "name": {
                        "firstName": "Bob",
                        "lastName": "Smith",
                        "otherNames": "H",
                        "title": "Mr"
                    },
                    "nationalIdentification": "SA211123K"
                },
                "language": "en-US",
                "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
                "paymentChannel": {
                    "accountName": "My account",
                    "accountNumber": "XXXXXX5678",
                    "countryCode": "US",
                    "currency": "USD",
                    "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
                    "paymentChannelName": "My Payment Channel",
                    "routingNumber": "XXXXX6789"
                },
                "payorRefs": [
                    {
                        "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                        "payableIssues": [
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            },
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            }
                        ],
                        "payableStatus": true,
                        "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                        "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                        "remoteId": "uniqueIdForRemoteEntity"
                    },
                    {
                        "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                        "payableIssues": [
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            },
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            }
                        ],
                        "payableStatus": true,
                        "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                        "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                        "remoteId": "uniqueIdForRemoteEntity"
                    }
                ],
                "remoteId": "Remote ID"
            },
            "failureMessage": "failure reason"
        },
        {
            "failedSubmission": {
                "address": {
                    "city": "Key West",
                    "country": "US",
                    "countyOrProvince": "FL",
                    "line1": "500 Duval St",
                    "line2": "line2",
                    "line3": "line3",
                    "line4": "line4",
                    "zipOrPostcode": "33945"
                },
                "challenge": {
                    "description": "challenge description",
                    "value": "challenge test"
                },
                "company": {
                    "name": "ABC Group Plc",
                    "operatingName": "ABC Co",
                    "taxId": "123123123"
                },
                "email": "bob@example.com",
                "individual": {
                    "dateOfBirth": "1970-05-20T00:00:00.000+0000",
                    "name": {
                        "firstName": "Bob",
                        "lastName": "Smith",
                        "otherNames": "H",
                        "title": "Mr"
                    },
                    "nationalIdentification": "SA211123K"
                },
                "language": "en-US",
                "payeeId": "2aa5d7e0-2ecb-403f-8494-1865ed0454e9",
                "paymentChannel": {
                    "accountName": "My account",
                    "accountNumber": "XXXXXX5678",
                    "countryCode": "US",
                    "currency": "USD",
                    "iban": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234",
                    "paymentChannelName": "My Payment Channel",
                    "routingNumber": "XXXXX6789"
                },
                "payorRefs": [
                    {
                        "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                        "payableIssues": [
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            },
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            }
                        ],
                        "payableStatus": true,
                        "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                        "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                        "remoteId": "uniqueIdForRemoteEntity"
                    },
                    {
                        "invitationStatusTimestamp": "2019-01-20T09:00:00Z",
                        "payableIssues": [
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            },
                            {
                                "code": "3",
                                "message": "payee-disabled"
                            }
                        ],
                        "payableStatus": true,
                        "paymentChannelId": "70faaff7-2c32-4b44-b27f-f0b6c484e6f3",
                        "payorId": "ba08877f-9d96-41e4-9c26-44a872d856ae",
                        "remoteId": "uniqueIdForRemoteEntity"
                    }
                ],
                "remoteId": "Remote ID"
            },
            "failureMessage": "failure reason"
        }
    ],
    "pendingCount": 2,
    "status": "SUBMITTED"
}

Request

Path Params

Responses

🟢200Get Batch Status

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:19

Initiate Payee Creation

Get Payee Invitation Status