Sign in
Instant Top-Ups

Create a Top-Up

Creates a Top-Up for the person's account specified in the request URL. Calling this endpoint will begin the payment process with Solaris and its acquiring partner (e.g., Stripe).<br> Note that you must provide the returned client_secret to the Acquirer's SDK (e.g., the Stripe PaymentIntent).

post/v1/persons/{person_id}/accounts/{account_id}/topups

Path parameters

person_idstring required
account_idstring required

Request body

payment_method_idstring

Example request

{
  "amount": {
    "value": 10000
  }
}

Response

The Top-Up was successfully created.

idstring required

Unique ID of the Top-Up.

acquirer_error_codestring nullable

Error code forwarded by the Acquirer's API (in case there was an error on the Acquirer's end).

acquirer_decline_codestring nullable

If the Acquirer declines the Top-Up, then this property will contain the decline code forwarded by the Acquirer's API.

cancellation_reason'abandoned' | 'duplicate' | 'fraudulent' | 'requested_by_customer' nullable

The reason why the Top-Up was cancelled. Only present if the status is 'CANCELLED'.

decline_reasonstring nullable

The reason why the Top-Up was declined. Usually present if the status is 'DECLINED' due to a technical issue.

client_secretstring

The client secret key provided by the Acquirer's API for use in their frontend SDK.

status'ACCEPTED' | 'CONFIRMED' | 'EXECUTED' | 'DECLINED' | 'CANCELLED' required

The current status of the Top-Up.

instruction_idstring nullable

Instruction ID of the Solaris credit transfer transaction.

Example response

{
  "id": "b76cdcc321d345618084feedc47bbb1d",
  "amount": {
    "value": 10000
  },
  "client_secret": "pi_1DrPlP2eZvKYlo2CSBQ7uqFH_secret_o1A7UsYFLWeGISUD1QYNkT8IU",
  "instruction_id": "3eba1ee2d8bc4d5883d350031a5fe9d8"
}