Skip to content

Pay Utility

Pay Utility

Performs payments of consumer bills and tickets.

HTTP Request

POST /wallets/{{walletId}}/utility

Request Headers
{
    "Content-Type": "application/json",
    "Authorization": "Bearer {{access_token}}"
}
Request Body
{
    "externalIdentifier": "280a03fc-2255-11eb-adc1-0242ac120002",
    "digitableLine": "836300000038519200481009600737826013000495468878",
    "amount": 100,
    "currency": "BRL",
    "dueDate": "2021-01-01"
}
Content-Type: application/json
{
    "code": 200,
    "errorMsg": "",
    "transactionId":"09461d96-2252-11eb-adc1-0242ac120002",
    "transferStatus":"IN_PROGRESS"
}

HTTP Headers Details

Key Value
Content-Type application/json
Accept application/json
Authorization "bearer"+ "" + {{access_token}}

PATH Parameters

Parameter Required Type Description
walletId String The walletId which was returned by API createWallet

JSON Body Parameters

Parameter Required Type Description
externalIdentifier String Unique key to ensure idempotent requests
digitableLine String Numeric representation of the bar code
dueDate String The expire data for bill, format as YYYY-MM-DD
amount String The transfer amount
currency String The currency of the transferred fund

Response Body Details

Parameter Type Description
statusCode int 200 Success, 401 Access denied, 422 Required fields missing or invalid data, 500 internal error
errorMsg String error message if failed
transactionId String The transaction id
transferStatus String Transfer status, settled, in progress or failed
Back to top