v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB

Payments

Get one-off payment

get/v1/one-off-payments/{paymentId}

Path parameters

paymentIdstring required

Example:one_off_payment_c01234567890123456789012345

Response

Success

_idstring required

The status of the payment

created_atstring date-time required

When the payment was created

updated_atstring date-time required

When the payment was last updated

expires_atstring date-time

The payment will be cancelled at this time, unless it has been authorised

submitted_atstring date-time

When the payment was submitted

terminal_atstring date-time

When the payment reached a terminal status

amountnumber required

The amount to be paid in dollars, e.g. 12.34. (Rounded to 2 decimal places).

redirect_uristring uri required

The URI to redirect the user to after payment approval

redirect_mode'deep_link'

The mode used by Akahu when redirecting the user to your provided redirect_uri. This option is important for native mobile app developers.

deep_link → Specify this value if your provided redirect_uri intends to activate your native mobile application via iOS universal link or Android app link. When you supply this value, the user will be required to tap to confirm before returning to your application. This interaction is important to ensure successful native app activation.

webhook_uristring uri

The URI to send webhooks regarding updates to this payment

Example response

{
  "_id": "one_off_payment_c01234567890123456789012345",
  "status": "SUBMITTED",
  "status_reason": {
    "code": "PENDING",
    "message": "The payment was submitted to the bank"
  },
  "payee": {
    "name": "John Smith",
    "account_number": "12-3456-7890123-00"
  },
  "payer": {
    "name": "Jane Smith",
    "account_number": "12-3456-7890123-10"
  },
  "amount": 12.34,
  "redirect_uri": "https://myapp.com/payments/complete",
  "webhook_uri": "https://myapp.com/payments/webhooks"
}