Sandbox
With a test secret key you can simulate what the payer does: an exact, partial, excess or late transfer, or an expiry. Simulations fire the same webhooks and realtime events as real transfers.
| post | /v1/sandbox/transactions/{id}/simulateSimulate a payment outcome (test mode only) | Simulate a payment outcome (test mode only) |
Read the Sandbox guide for the concepts behind these endpoints.
Simulate a payment outcome (test mode only)
/v1/sandbox/transactions/{id}/simulatePath parameters
idstringrequired |
Request bodyapplication/json
outcomestringrequired | One of |
amountinteger | Amount the simulated payer transfers. Defaults depend on outcome. > 0, ≤ 100000000000 |
payer_namestring | max length 100 |
Responses
Show response attributesHide response attributes
idstringrequired | Yusr transaction ID, prefixed txn_. | ||||||||||||
objectstringrequired | always "transaction" | ||||||||||||
modestringrequired | One of | ||||||||||||
statusstringrequired | One of | ||||||||||||
amountintegerrequired | Amount requested, in kobo. | ||||||||||||
amount_receivedintegerrequired | Sum of all payments received, in kobo. | ||||||||||||
feeintegerrequired | Yusr fee in kobo. | ||||||||||||
fee_bearerstringrequired | One of | ||||||||||||
net_amountintegerrequired | Amount settled to you after fees, in kobo. | ||||||||||||
currencystringrequired | always "NGN" | ||||||||||||
referencestringrequired | |||||||||||||
descriptionstring | nullrequired | |||||||||||||
customerobjectrequired | Show child attributesHide child attributes
| ||||||||||||
paymentobjectrequired | Show child attributesHide child attributes
| ||||||||||||
flagsobjectrequired | Show child attributesHide child attributes
| ||||||||||||
paymentsarray of objectrequired | Show child attributesHide child attributes
| ||||||||||||
metadataobject of anyrequired | |||||||||||||
created_atstringrequired | |||||||||||||
updated_atstringrequired | |||||||||||||
paid_atstring | nullrequired | |||||||||||||
expires_atstringrequired |