Skip to main content
POST
https://staging.api.tribease.com/v2
/
v2
/
payment-intents
Create new Payment Intent
curl --request POST \
  --url https://staging.api.tribease.com/v2/v2/payment-intents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "customerEmail": "<string>",
  "currency": "<string>",
  "clientReference": "<string>",
  "receiptEmail": "<string>",
  "paymentMethod": [
    {}
  ],
  "callbackUrl": "<string>",
  "settlementAccounts": [
    {}
  ]
}
'
{
  "id": "<string>",
  "amount": "<string>",
  "totalAmount": "<string>",
  "currency": "<string>",
  "receiptEmail": "<string>",
  "customerEmail": "<string>",
  "country": "<string>",
  "status": "<string>",
  "checkoutLink": "<string>",
  "clientReference": "<string>",
  "paymentMethods": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": [
        {
          "name": "<string>"
        }
      ]
    }
  ],
  "callbackUrl": "<string>",
  "transaction": "<string>",
  "meta": [
    {}
  ],
  "settlementAccounts": [
    {
      "settlementAccountId": "<string>",
      "splitAmount": "<string>"
    }
  ],
  "createdAt": {},
  "updatedAt": {}
}

Request Body Parameters

amount
integer
required
The Payment Intent amount.
customerEmail
string
required
Email of the customer.
currency
string
default:"NGN"
required
The currency of the amount. The only currency currently supported is NGN.
clientReference
string
required
A unique reference from your app.
receiptEmail
string
required
Email to send receipt of the transaction to.
paymentMethod
array
The allowed payment methods to be used for payment. Possible values include: Flutterwave.
callbackUrl
string
The URL to redirect user to after a payment attempt.
settlementAccounts
array
The Settlement Account IDs that payments received should go into. Multiple settlement account ids can be added alongside the amount to be settled. The key for each array index should be: settlementAccountId (for the settlement account id) and splitAmount (for the amounts)

Response Data

id
string
required
The ID of the Payment Page
amount
string
required
Amount
totalAmount
string
required
Total Amount that will be paid out
currency
string
required
Currency
receiptEmail
string
Email to receive transaction receipt. If no value is specified, the customer email will get transaction receipt
customerEmail
string
required
Email of the customer
country
string
Country of the Payment Intent
status
string
required
Payment Intent status
Payment Intent link.
clientReference
string
required
Payment Intent unique reference supplied by the client.
paymentMethods
array
callbackUrl
string
Callback URL
transaction
string
Transaction reference associated with the Payment Intent
meta
array
More information about the payment page
settlementAccounts
array
createdAt
datetime
required
Payment Page created time.
updatedAt
datetime
required
Payment Page updated time.