Create a payment request
Request body which must comply to the following JSON Schema:
{
"required" : [ "cart", "contactId", "reference" ],
"type" : "object",
"properties" : {
"reference" : {
"type" : "string",
"description" : "Reference of the payment request, it will appear on the payment page.\n",
"example" : "Invoice #INV0001"
},
"cart" : {
"required" : [ "currency", "specificAmount" ],
"type" : "object",
"properties" : {
"currency" : {
"type" : "string",
"description" : "Currency code for the payment amount.\n",
"example" : "EUR",
"enum" : [ "EUR" ]
},
"specificAmount" : {
"type" : "integer",
"description" : "Payment amount, in cents.\ne.g. if you want to request €12.00, then the amount in cents is 1200.\n",
"format" : "int64",
"example" : 1200
}
},
"description" : "Specify the payment currency and amount.\n"
},
"contactId" : {
"type" : "integer",
"description" : "Brevo ID of the contact requested to pay.\n",
"format" : "int64",
"example" : 43
},
"description" : {
"type" : "string",
"description" : "description of payment request\n",
"example" : "Shipping Cost for sending bottles to NYC"
},
"notification" : {
"required" : [ "channel", "text" ],
"type" : "object",
"properties" : {
"channel" : {
"type" : "string",
"description" : "Channel used to send the notifications.\n",
"example" : "email",
"enum" : [ "email" ]
},
"text" : {
"type" : "string",
"description" : "Use this field if you want to give more context to your contact about the payment request.\n",
"example" : "Please pay for your yoga class."
}
},
"description" : "Optional. Use this object if you want to let Brevo send an email to the contact, with the payment request URL. If empty, no notifications (message and reminders) will be sent.\n"
},
"configuration" : {
"required" : [ "customSuccessUrl" ],
"properties" : {
"customSuccessUrl" : {
"type" : "string",
"description" : "Absolute URL of the custom success page.\n",
"format" : "url",
"example" : "https://my-company.com/payment-success"
}
},
"description" : "Optional. Redirect contact to a custom success page once payment is successful. If empty the default Brevo page will be displayed once a payment is validated\n"
}
}
}
