API Reference
Contact Sales

Preview Payment

post
https://api.sandbox.devengo.com/v1/payments/preview

This endpoint lets API clients know how Devengo will process a payment beforehand. Consumers can use the preview to inform final users if they get their money instantly, the estimated time of funds arrival, etc.

Body Params
string
required
string

Any piece of information provided to identify this payment. This is usually an ID on external systems related to the entity (an invoice, an order) that originates the payment. If the structure of data you want to attach is more complex than a string please use the metadata attribute.

destination
object
required
string

Legal name of the beneficiary.

string

The text that will appear on the origin and destination account statements.

amount
object
required
metadata
object

Set of key-value pairs to store in the created Payment. This data will be included in the payload of any subsequent API call and Webhook that returns this object.

Headers
string

e.g. tst_apk_7CxsfgaaGResQUmymUf4VV

string

e.g. f04bc3ba6455738e7ece32c1c25bac8b

string

e.g. 1584230400

string

e.g. XQEm3hpysmTczzu3Pvm3DI+MrI+wVGk102RpCZRPTN0=

Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8
Updated 7 months ago