Get Payment Accounts

This method is used to retrieve the details of the virtual NGN bank account created by Oval for the customer on behalf of the fintech partner
Search query for this endpoint is the customers' unique customer_id.

HTTP Method : POST
API Endpoint : {{base_url}}/api/v1/payments/banks/account?customer_id={{customer_id}}¤cy={{currency}}

Sample cURL Request

curl --location --request GET 'https://sandbox-api.ovalfi-app.com/api/v1/payments/banks/account?customer_id=7809c40e-efd1-4764-a063-3f48c660b241&currency=EUR'

Response Parameters

{
    "status": 200,
    "data": {
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "customerID": "6ba7b810-9dad-11d1-80b4-00c04fd430c9",
        "businessID": "6ba7b810-9dad-11d1-80b4-00c04fd430c0",
        "accountID": "ACC123456",
        "accountDetail": {
          "iban": "",
          "sortCode": "",
          "notes": null,
          "bankPhone": "",
          "reference": "",
          "swiftCode": null,
          "bankAddress": "",
          "accountName": "John Doe",
          "accountNumber": "12345678",
          "bankName": "Alat Bank",
          "bankCode": "022",
          "routingNumber": "",
          "beneficiaryAddress": ""
        },
        "reference": "REF123456",
        "currency": "NGN",
        "createdAt": "2024-02-28T12:00:00Z",
        "updatedAt": "2024-02-28T13:30:00Z",
        "deletedAt": null
      },
    "message": "Successfully retrieved account details",
    "error": null
}