Return Requests
Accept return request
Accept a return request for an incoming payment previously received. Accepting a return request creates a return. See Create a return.
post/return_requests/{id}/accept
Request
- Base URLhttps://sandbox.numeral.io/v1
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
The ID of the return request.
Response
Successfully accepted return request, and the associated return which has been created.
Example response
{
"return": {
"object": "return",
"metadata": {
"property_a": true,
"property_b": "false"
},
"originating_account_bank_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
},
"receiving_account_bank_address": {
"line_1": "1, place de la Concorde",
"building_number": "1",
"street_name": "place de la Concorde",
"postal_code": "75008",
"city": "Paris",
"country": "FR",
"department": "Marketing",
"sub_department": "Content team",
"building_name": "Bat. 4",
"floor": "3",
"postal_box": "67b",
"room": "47",
"city_location_name": "Confluences",
"district_name": "District 9"
}
},
"return_request": {
"object": "return_request",
"metadata": {
"property_a": true,
"property_b": "false"
},
"additional_information": [
"Insufficient funds",
"Account closed"
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.