Get Payout Document Template

This API is called to generate the payout document URL template.

HTTP Method : GET
API Endpoint : {{base_url}}/api/v1/payouts/template?currency={{currency}}

Sample cURL Request

curl --location 'https://sandbox-api.ovalfi-app.com/api/v1/payouts/template?currency=NGN' \
--header 'Authorization: Bearer eyJidXNpbmVzc0lEIjoiYmEwY2E1NGMtZjRkYi00NDU5LWE4MDYtOTZkYzA3NWIzZjlkIiwidXNlcklEIjoiM2E5NjhiOWYtMzU5MC00ODZhLWE1MTMtYzg2MzkzZjZmYWI4Iiwia2V5IjoiaGFsZWVtYWgifQ==' \
--header 'Signature: 8042e424f924a236e9c8b4c6a76991ffeee24328d39cbb8a31d16cbca9948bf2'

Response Parameters

{
    "status": 200,
    "data": {
        "requestID": "089098fd-51cf-49d7-942e-5468aace5d49",
        "url": "https://oval-resources.s3.us-east-2.amazonaws.com/Sample+NGN+Bulk+Payout+Instruction+%2B+Bank+Codes.xlsx"
    },
    "message": "Payout document template url retrieved successfully!",
    "error": null
}