API reference

Create return

post
https://sandbox.numeral.io/v1/returns

Create a return on a payment. It only applies to financial institution payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required

The ID of the incoming payment to be returned.

string
required

Authorised reasons depend on the payment scheme. For SEPA, refer to SEPA reason codes. For FPS, refer to the 8 digits FPS return reason codes.

metadata
object

Additional client data in JSON format. See Metadata.

boolean
Defaults to false

Indicates whether the funds should be debited from your suspense account or the customer account. false by default (i.e. funds will be debited on your customer account).

Responses

404

The specified resource was not found.

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago