Skip to main content

SimulatePaymentCompletionRequest

Request to complete an existing sandbox crypto payment in sandbox environments

paymentRequestReferencestringrequired

Identifies the payment request. Supply any one of: its paymentLinkReference (shown in the payment URL, e.g. AH-LGWO-MGYL), its Hubpay id (the UUID from the create response), or your own externalId. The legacy JSON field name paymentRequestId is also accepted.

Possible values: non-empty

Example: AH-LGWO-MGYL
paymentIdstring<uuid>required

ID of the crypto payment to complete: the id of the entry in the payment request's payments array, or paymentId returned by simulate-crypto-deposit. The deposit must be confirmed; a newly created checkout quote is not enough.

Example: e9df7b8b-2276-4941-9f87-c4b556c5382d
SimulatePaymentCompletionRequest
{
  "paymentRequestReference": "AH-LGWO-MGYL",
  "paymentId": "e9df7b8b-2276-4941-9f87-c4b556c5382d"
}