API reference

Create payment capture

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

Create a payment capture, that can be used for reconciliation purposes.

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

The ID of the connected account.

string

The transaction reference of the payment capture.

int64
required

The absolute amount of a payment, in the specified currency's smallest units. For euro payments, the smallest unit is cents. €20 is represented as 2000.

string
required

The ISO 4217 currency code of the payment capture.

string
enum
required

The type of the payment capture.

Allowed:
string

The authorization ID of the payment capture.

string
required

The payment reference of the payment capture (e.g. archiving reference).

date
required

The date of the payment capture.

metadata
object

Additional client data in JSON format. See Metadata.

Headers
string

An idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request.

Responses

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