Mandates (BECS)

Get BECS AU MandateDeprecated

Role Requirements

tenant-mandate-read or tenant-admin

Description

Get BECS AU mandate.

Securitybearer
Request
path Parameters
mandateId
required
string <uuid> = 36 characters

The system's unique identifier for the mandate (lowercase and hyphenated).

Example: 719d246a-7c03-4a47-9dc5-924a0df12889
header Parameters
x-account-id
required
string <uuid> = 36 characters

The Account Id (lowercase and hyphenated).

Example: 1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid> = 36 characters

The Tenant Id (lowercase and hyphenated).

Example: ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string

Correlation Id for the request.

Responses
200

Returns a BECS AU mandate.

401

Unauthorized

403

Forbidden

404
  • Not Found - Mandate '00000000-0000-0000-0000-000000000000' was not found.
get/v2/mandates/becsau/{mandateId}
Request samples 
Response samples 
application/json
{
  • "mandateId": "42bd41f5-2d37-4ebc-8e48-a5fdd309f578",
  • "mandateRef": "AYJ3BR4H67",
  • "network": "BecsAu",
  • "mandateType": "BecsAuB2C",
  • "customerRef": "customer1",
  • "status": "Active",
  • "creditorProfileRef": "fb39d6eb3ac44d6597f0f7221da5e663",
  • "financialInstrumentId": "d28a4016-a824-400b-9019-a35af2129f47",
  • "created": "2023-01-01T12:00:00Z",
  • "debtor": {
    • "firstName": "John",
    • "lastName": "Smith",
    • "companyName": "J SMITH LTD",
    • "email": "JohnDangerSmith@imbursepayments.com",
    • "address": {
      • "houseNumberOrName": "5",
      • "streetAddress": "Adelaide Avenue",
      • "city": "Deakin",
      • "postcode": "ACT2600",
      • "country": "AU"
      },
    • "accountHolderName": "J SMITH",
    • "accountNumber": "12345678",
    • "bsbNumber": "123456"
    }
}
Get BECS NZ MandateDeprecated
Role Requirements


tenant-mandate-read or tenant-admin


Description


Get BECS NZ mandate.


Securitybearer 
Request 
path Parameters
mandateId
required
string <uuid>   = 36 characters 
The system's unique identifier for the mandate (lowercase and hyphenated).


 
 Example:  719d246a-7c03-4a47-9dc5-924a0df12889
header Parameters
x-account-id
required
string <uuid>   = 36 characters 
The Account Id (lowercase and hyphenated).


 
 Example:  1aa81e1e-b072-4e64-b1ec-fdcc54f2d08c
x-tenant-id
required
string <uuid>   = 36 characters 
The Tenant Id (lowercase and hyphenated).


 
 Example:  ef848af6-4d8f-4b62-88c4-4856dd2aec02
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
Returns a BECS NZ mandate.


401
Unauthorized


403
Forbidden


404
    

  • Not Found - Mandate '00000000-0000-0000-0000-000000000000' was not found.
    • 



get/v2/mandates/becsnz/{mandateId}
Request samples 
Response samples 
application/json
{
  • "mandateId": "42bd41f5-2d37-4ebc-8e48-a5fdd309f578",
  • "mandateRef": "AYJ3BR4H67",
  • "network": "BecsNz",
  • "mandateType": "BecsNzB2C",
  • "customerRef": "customer1",
  • "status": "Active",
  • "creditorProfileRef": "fb39d6eb3ac44d6597f0f7221da5e663",
  • "financialInstrumentId": "d28a4016-a824-400b-9019-a35af2129f47",
  • "created": "2023-01-01T12:00:00Z",
  • "debtor": {
    • "firstName": "John",
    • "lastName": "Smith",
    • "companyName": "J SMITH LTD",
    • "email": "JohnDangerSmith@imbursepayments.com",
    • "address": {
      • "houseNumberOrName": "Beehive",
      • "streetAddress": "Pipitea",
      • "city": "Wellington",
      • "postcode": "6011",
      • "country": "NZ"
      },
    • "accountHolderName": "J SMITH",
    • "accountNumber": "123113000386900",
    • "bankName": "Bank of New Zealand",
    • "signatoryName": "JOHN SMITH"
    }
}
Copyright 2025 Duck Creek Technologies. All Rights Reserved.