capabilities.work

Payout, Query, and Refund

A 3-step recipe with Cellulant. We can help you get access.

Recipe · 3 steps

Payout, Query, and Refund

Disburse a payout, query its outcome, and refund it when it did not succeed.

  1. Disburse the payout with function BEEP.postPayment.
  2. Query the payout outcome with function BEEP.queryPayment. Branch to a refund when the payout is still pending (status code 139); otherwise end.
  3. Reverse the payout with function BEEP.refundPayment when the query reported it did not complete.
What you'll need to have ready
  • basicAuth: Base64-encoded Beep Basic auth credentials for the Authorization header.
  • username: Beep payload credential username.
  • password: Beep payload credential password.
  • countryCode: ISO 3166-1 alpha-2 country code.
  • serviceCode: Beep service code identifying the payout rail.
  • msisdn: Customer mobile number with country code.
  • accountNumber: Destination account number.
  • payerTransactionId: Unique merchant payer transaction id used across all three steps.
  • amount: Payout amount.
  • datePaymentReceived: Payment received timestamp (yyyy-mm-dd hh:mm:ss).
  • currencyCode: Currency code for the payout.
  • narration: Free-text narration for the payout.
For your developer

Arazzo workflow cellulant:payout-query-and-refund, 3 operations: postPayment → postPayment → postPayment. Specs on APIs.io.