Easy Labs
APIAccount & operationsBill pay

Confirm a bill payment 2FA challenge

Submit the 2FA code (and the transaction_id returned by /confirm) to finish a payment that required two-factor authentication. On success the bill moves to processing and the payment is submitted to Brale.

POST
/v1/api/billpay/{id}/confirm-2fa

Authorization

apiKey
x-easy-api-key<token>

Merchant API key. Publishable keys (pk_test_* / pk_live_) are safe for browser/frontend use and carry a limited scope set (sessions, payment_instruments, customers, orders writes; products, product_prices, payment_links reads). Secret keys (sk_test_ / sk_live_*) grant full admin access and must only be used server-side.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/v1/api/billpay/497f6eca-6276-4993-bfeb-53cbbbba6f08/confirm-2fa" \  -H "Content-Type: application/json" \  -d '{    "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",    "code": "string"  }'
{
  "success": true,
  "timestamp": "2019-08-24T14:15:22Z",
  "data": null,
  "message": "string",
  "pagination": {
    "total": 0,
    "limit": 1,
    "offset": 0,
    "has_more": true,
    "truncated": true,
    "cursors": {
      "first": "string",
      "last": "string"
    }
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}
{
  "success": false,
  "timestamp": "2019-08-24T14:15:22Z",
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}

Cancel a bill submission

Cancel a bill. A linked treasury transaction is also cancelled if it has not yet been submitted to Brale.

Confirm a bill payment

Confirm a bill and submit the payment to Brale on the merchant's own account. The bill must be in extracted/review/confirmed status with a matched recipient.