Skip to main content
POST
/
v5
/
payouts
/
payout
Save a payout
curl --request POST \
  --url https://sandbox.hurdlr.com/rest/v5/payouts/payout \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "payout": {
    "bankTransferId": 123,
    "status": "ACTIVE",
    "type": "CONFIRMED",
    "amount": 50.01,
    "date": "2021-01-04",
    "description": "Online Banking payment",
    "creditAccountId": 123,
    "debitAccountId": 123,
    "apiTransactionId": "<string>",
    "bankAccountId": 123,
    "bankDescription": "<string>",
    "apiAccountNo": "<string>",
    "apiAccountName": "Citi Premier® Card",
    "apiInstitutionId": "<string>",
    "matchingBankTransferId": 123,
    "customData": {},
    "transactions": [
      {
        "entity": "EXPENSE",
        "entityId": 123,
        "status": "ACTIVE",
        "amount": 123,
        "date": "2023-11-07T05:31:56Z",
        "bankAccountId": 123,
        "description": "<string>",
        "bankDescription": "<string>",
        "apiTransactionId": "<string>",
        "apiAccountId": "<string>",
        "apiAccountNo": "<string>",
        "apiAccountName": "Citi Premier® Card",
        "apiInstitutionId": "<string>",
        "customData": {}
      }
    ]
  }
}
'
{
  "result": "SUCCESS",
  "errors": {
    "fieldErrors": {},
    "globalErrors": [
      {
        "type": "DUPLICATE",
        "errorMessage": "<string>"
      }
    ]
  },
  "id": "<string>",
  "webhook": {
    "userId": "<string>",
    "accountantUserId": "<string>",
    "type": "ENTITY_UPDATE"
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

*/*

payout object

payout
object

Response

200 - application/json

Successful operation

Object containing details about result of the action performed

result
enum<string>

The result of the action performed

Available options:
SUCCESS,
FAILURE
errors
object

Error object containing details errors incurred, if any

id
string

Id of the entity being acted upon

webhook
object