Fileactive Payment API Fileactive Payment API
API docs by Redocly

Fileactive Payment API (2.1.0)

Download OpenAPI specification:Download

The Fileactive payment APIs support payment initiations and status confirmations aross various countries.
A maximum of 1 batch (payment_information object) containing up to 1000 transactions (credit_transfer_transaction_information objects) per request is supported.

Authorisation

Operations related to authentication & authorisation.

Auth Token Request

ANZ use OAuth 2.0 to authenticate inbound token requests, a bearer token is returned as a response which is then used to authorise against ANZ resources

Authorizations:
(apiKeyAuthoAuth2)
Request Body schema: application/x-www-form-urlencoded
required

Information and examples of Auth request body

grant_type
required
string

Specify the type credential requested

client_assertion_type
required
string

Describes the type of client assertion provided in the message request

scope
required
any
required
object (ClientAssertion)

Responses

Response samples

Content type
application/json
{
  • "expires_in": 3600,
  • "token_type": "Bearer",
  • "access_token": "eaaa13ee-b596-a8cc-b9d4-f778f8bb9377"
}

Australia Payments

Operations related to Australian payments.

AU NPP Submit

Payment initiation request related to a single credit transfer between a debtor and creditor.

Error and Event Codes
Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. X- Message-Id will be used as the {transaction_identification} parameter to retrieve payment status.

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor, object: #/definitions/PaymentSubmissionResource

secured_payload
string

Pain001: PaymentSubmissionResource

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "string"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

AU NPP Status

Retrieve and return the status of a submited AU NPP message.

Authorizations:
(apiKeybearerAuth)
path Parameters
transaction_identification
required
string

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

header Parameters
x-Correlation-Id
string

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
{
  • "transaction_identification": "32d292f1-ee65-11ea-84ce-3d837763b9eb",
  • "transaction_status": "ACTC",
  • "transaction_status_description": "Processing",
  • "acceptance_date_time": "2020-09-04T04:15:04.631Z"
}

AU CBFT Submit

Australian Cross Border Fund Transfer API using pain.001.001.09 derived json message format. Payment Initiation request using AU CBFT from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_AU_CBFT for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Resource to instruct movement of funds from the debtor account to creditor

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

AU CBFT Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

India Payments

Operations related to Indian payments.

IN ACH Submit

India ACH API using pain.001.001.09 derived json message format. Payment Initiation request using IN ACH from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_ACH for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

IN ACH Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

Hong Kong Payments

Operations related to Hong Kong payments.

HK ACH Submit

Hong Kong ACH API using pain.001.001.09 derived json message format. Payment Initiation request using ACH from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_ACH for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

HK ACH Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

HK FPS Submit

Hong Kong FPS API using pain.001.001.09 derived json message format. Payment Initiation request using Hong Kong FPS (Faster Payment System) from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_FAST for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

HK FPS Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

HK RTGS Submit

Hong Kong RTGS API using pain.001.001.09 derived json message format. Payment Initiation request using Hong Kong RTGS (Real Time Gross Settlement) service from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_RTGS for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

HK RTGS Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

HK CBFT Submit

Hong Kong CBFT API using pain.001.001.09 derived json message format. Payment Initiation request using Hong Kong CBFT (Cross Border Fund Transfer) service from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_CBFT for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

HK CBFT Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

Singapore Payments

Operations related to Singapore payments.

SG ACH Submit

Singapore ACH API using pain.001.001.09 derived json message format. Payment Initiation request using ACH from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_ACH for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

SG ACH Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

SG FAST Submit

Singapore FAST API using pain.001.001.09 derived json message format. Payment Initiation request using Singapore FAST (Fast And Secure Transfers) service from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_FAST for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

SG FAST Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

SG RTGS Submit

Singapore RTGS API using pain.001.001.09 derived json message format. Payment Initiation request using Singapore RTGS (Real Time Gross Settlement) service from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_RTGS for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpbnN0cnVjdGlvbl9pZGVudGlmaWNhdGlvbiI6IlRDMTIxLzE0NzE4NzM4MjMiLCJlbmRfdG9fZW5kX2lkZW50aWZpY2F0aW9uIjoiTk9UUFJPVklERUQiLCJjcmVhdGlvbl9kYXRlX3RpbWUiOiIyMDE4LTA5LTE3VDA5OjQ1OjQ3WiIsImluaXRpYXRpbmdfcGFydHlfbmFtZSI6IkN1c3RvbWVyQSIsInJlcXVlc3RlZF9leGVjdXRpb25fZGF0ZSI6IjIwMTgtMDktMTciLCJkZWJ0b3JfbmFtZSI6IkJJTEJPIEJBR0dJTlMiLCJkZWJ0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMzQyMTIzNDU2NyIsImRlYnRvcl9hY2NvdW50X3R5cGUiOiJCQkFOIiwiaW5zdHJ1Y3RlZF9hbW91bnQiOnsiY3VycmVuY3kiOiJBVUQiLCJhbW91bnQiOiI1NjIuODkifSwiY3JlZGl0b3JfbmFtZSI6IlNBTVdJU0UgR0FNR0VFIiwiY3JlZGl0b3JfYWNjb3VudF9pZGVudGlmaWNhdGlvbiI6IjAxMDE2OTg3NjU0MzIxIiwiY3JlZGl0b3JfYWNjb3VudF90eXBlIjoiQkJBTiIsImNyZWRpdG9yX2FnZW50X2JpYyI6Ik5PVFBST1ZJREVEIiwicmVtaXR0YW5jZV9pbmZvcm1hdGlvbl91bnN0cnVjdHVyZWQiOlsiRklSU1QgTElORSIsIlNFQ09ORCBMSU5FIl19.aR2RMEVTuOOI1YuUCf2Ppo3Bwtf2_91WMvLd3IIA0ToHBDn0II36FumIz2RrwiUNHBMZo41Qmjv_zt9TQbq61csx2lRZcQNNsstAXKZWI4oZjlBaenj3HvY2_ztxS2IPNZNlVUQrw8A51-1dm-EeVTsqwhxs-Ir6d1FCee5SaNBrhtfaDBGAwjtXolPJuyYve0J3F8X-JwKPLBUaQH5LgGlTOSasC0vsKqhfpZOc-3rS39UA7q0jHQyqcJKrhinEyWlTFU9PcOh2W4-0hXiPaLJ_PA-_EkY5kYBnBvUWofVy35ZnB_u0wv0gxvVVDYKLGUpOGblaWRUY09SHx52Njw"
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

SG RTGS Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

SG CBFT Submit

Singapore CBFT API using pain.001.001.09 derived json message format. Payment Initiation request using Singapore CBFT (Cross Border Fund Transfer) service from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_CBFT for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

SG CBFT Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

Vietnam Payments

Operations related to Vietnam Payments

VN ACH Submit

Vietnam ACH API using pain.001.001.09 derived json message format. Payment Initiation request using ACH from single debtor to single or multiple creditors.
Refer to CustomerCreditTransferInitiationV09_ASIA_ACH for unencrypted payload object.

Authorizations:
(apiKeybearerAuth)
header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Duplicate check using point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message

Request Body schema: application/json
required

Secured resource to instruct movement of funds from the debtor account to creditor.

secured_payload
required
string

Encrypted and secured payment payload

Responses

Request samples

Content type
application/json
{
  • "secured_payload": {
    }
}

Response samples

Content type
application/json
{
  • "transaction_status": "RCVD"
}

VN ACH Status

Retrieve and return the status of a submited message.

Authorizations:
(apiKeybearerAuth)
path Parameters
x-Message-Id
required
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Message Identifier as provided in x-Message-Id header of message submission

header Parameters
x-Correlation-Id
string (UUID) [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{...
Example: 71d6fb19-7515-40dc-b045-e17550b67600

Optional correlation ID provided by the data consumer that should be reflected back in the response headers. Can be used for reporting and logging.

Responses

Response samples

Content type
application/json
Example
{
  • "group_status": "ACSC",
  • "original_payment_information_and_status_details": [
    ]
}

CustomerCreditTransferInitiationV09

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects (PaymentInformation) non-empty

Information related to the individual payments with a single API submission.

{
  • "creation_date_time": "string",
  • "number_of_transactions": "string",
  • "control_sum": "string",
  • "initiating_party_name": "string",
  • "initiating_party_bic": "string",
  • "initiating_party_identification": "string",
  • "payment_information": [
    ]
}

CustomerPaymentStatusReportV10

group_status
required
string (ExternalPaymentGroupStatus1Code) [ 1 .. 4 ] characters
Enum: "RCVD" "ACTC" "RJCT" "PART" "PDNG" "ACSC"

Specifies the status of a group of payment instructions, as published in an external payment group status code set.

group_status_reason_code
string (ExternalStatusReason1Code) [ 1 .. 4 ] characters

Specifies the status reason, as published in an external status reason code list.

group_status_additional_information
Array of strings (Max105Text) [ items [ 1 .. 105 ] characters ]

Additional information relating to the status code and reason.

Array of objects (OriginalPaymentInformationAndStatus)

Details concerning the status of the individual transactions.

{
  • "group_status": "RCVD",
  • "group_status_reason_code": "NARR",
  • "group_status_additional_information": [
    ],
  • "original_payment_information_and_status_details": [
    ]
}

NPPPaymentSubmissionResource

instruction_identification
required
string [ 1 .. 35 ] characters

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.

end_to_end_identification
required
string [ 1 .. 35 ] characters

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.

creation_date_time
required
string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date and time at which the request was created.

initiating_party_name
required
string [ 1 .. 140 ] characters

Name by which the Initiating Party is known and which is usually used to identify that party.

initiating_party_bic
string^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".

instruction_priority
string
Enum: "HIGH" "NORM"

Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.

service_level
string [ 1 .. 35 ] characters

Specifies a pre-agreed service or level of service between the parties, as a proprietary code.

local_instrument
string

Specifies the local instrument, as published in an external local instrument code list.

category_purpose
string

Category purpose, as published in an external category purpose code list.

requested_execution_date
required
string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Specified date.

debtor_name
required
string [ 1 .. 140 ] characters

Name by which a party is known and which is usually used to identify that party.

debtor_alias_type
string
Enum: "TELI" "EMAL" "AUBN" "ORGN"

Contains the type of Alias Identifier. TELI - TELEPHONE NUMBER EMAL - EMAIL ADDRESS AUBN - AUSTRALIAN BUSINESS NUMBER ORGN - ORGANISATION ID

debtor_alias_value
string [ 1 .. 2048 ] characters

Contains the actual value for the supplied type, so an email address, a phone number etc. Refer to Alias Processing section for more detail

debtor_account_identification
string [ 1 .. 34 ] characters

Unique and unambiguous identification for the account between the account owner and the account servicer.

debtor_account_type
string
Enum: "BBAN" "AIIN"

Name of the account identification identification scheme. BBAN - BSB and ACCOUNT NUMBER AIIN - CREDIT CARD

debtor_agent_bic
string^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".

required
object (ActiveOrHistoricCurrencyAndAmount)
creditor_name
required
string [ 1 .. 140 ] characters

Name by which a party is known and which is usually used to identify that party.

creditor_alias_type
string
Enum: "TELI" "EMAL" "AUBN" "ORGN"

Contains the type of Alias Identifier. TELI - TELEPHONE NUMBER EMAL - EMAIL ADDRESS AUBN - AUSTRALIAN BUSINESS NUMBER ORGN - ORGANISATION ID

creditor_alias_value
string [ 1 .. 2048 ] characters

Contains the actual value for the supplied type, so an email address, a phone number etc. Refer to Alias Processing section for more detail./

creditor_account_identification
string [ 1 .. 34 ] characters

Unique and unambiguous identification for the account between the account owner and the account servicer.

creditor_account_type
string
Enum: "BBAN" "AIIN"

Name of the account identification identification scheme BBAN - BSB and ACCOUNT NUMBER AIIN - CREDIT CARD

creditor_agent_bic
required
string^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362 "Banking - Banking telecommunication messages - Business identifier code (BIC)".

remittance_referred_document_type
string [ 1 .. 35 ] characters

Specifies the type of referred document.

remittance_referred_document_number
string [ 1 .. 35 ] characters

Unique and unambiguous identification of the referred document.

remittance_referred_related_date
string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Date associated with the referred document.

remittance_information_unstructured
Array of strings <= 2 items [ items [ 1 .. 140 ] characters ]

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

{
  • "service_level": "npp.clear.01-x2p1",
  • "instruction_identification": "TC121/1471873823",
  • "end_to_end_identification": "NOTPROVIDED",
  • "creation_date_time": "2018-09-17T09:45:47Z",
  • "initiating_party_name": "HITACHI INTERNATIONAL",
  • "initiating_party_bic": "HITLSGSG",
  • "instruction_priority": "HIGH",
  • "local_instrument": "TRF",
  • "category_purpose": "SSBE",
  • "requested_execution_date": "2018-09-17",
  • "debtor_name": "BILBO BAGGINS",
  • "debtor_account_identification": "013434992345677",
  • "debtor_account_type": "BBAN",
  • "debtor_agent_bic": "ANZBAU3MXXX",
  • "instructed_amount": {
    },
  • "creditor_name": "SAMWISE GAMGEE",
  • "creditor_alias_type": "TELI",
  • "creditor_alias_value": "+61-4123456789",
  • "creditor_account_identification": "62016987654321",
  • "creditor_account_type": "BBAN",
  • "creditor_agent_bic": "NOTPROVIDED",
  • "remiitance_referred_document_type": "CINV",
  • "remittance_referred_document_number": "INV-12345678",
  • "remittance_referred_related_date": "2018-08-23",
  • "remittance_information_unstructured": [
    ]
}

NPPPaymentStatusResource

transaction_status
required
string
Enum: "RCVD" "ACTC" "ACSC" "RJCT"

Specifies the status of a transaction, in a coded form. RCVD - RECEIVED ACTC - ACCEPTED ACSC - SETTLED RJCT - REJECTED

transaction_status_reason_code
string

Reason for the status, as published in an external reason code list.

transaction_status_description
string [ 1 .. 105 ] characters

Further details on the status reason.

transaction_identification
string [ 1 .. 36 ] characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain.

acceptance_datetime
string^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

Point in time when the payment order from the initiating party meets the processing conditions of the account servicing agent. This means that the account servicing agent has received the payment order and has applied checks such as authorisation, availability of funds.

{
  • "transaction_identification": "32d292f1-ee65-11ea-84ce-3d837763b9eb",
  • "transaction_status": "ACTC",
  • "transaction_status_description": "Processing",
  • "acceptance_date_time": "2020-09-04T04:15:04.631Z"
}

CustomerCreditTransferInitiationV09_ASIA_ACH

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects non-empty

Information related to the individual payments with a single API submission.

[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

CustomerCreditTransferInitiationV09_ASIA_FAST

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects non-empty

Information related to the individual payments with a single API submission.

[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

CustomerCreditTransferInitiationV09_ASIA_RTGS

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects non-empty

Information related to the individual payments with a single API submission.

[
  • {
    },
  • {
    },
  • {
    }
]

CustomerCreditTransferInitiationV09_ASIA_CBFT

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects non-empty

Information related to the individual payments with a single API submission.

[
  • {
    },
  • {
    }
]

CustomerCreditTransferInitiationV09_AU_CBFT

creation_date_time
required
string (ISODateTime) ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]...

A particular point in the progression of time defined by a mandatory date and a mandatory time component, expressed in either UTC time format (YYYY-MM-DDThh:mm:ss.sssZ), local time with UTC offset format (YYYY-MM-DDThh:mm:ss.sss+/-hh:mm), or local time format (YYYY-MM-DDThh:mm:ss.sss). These representations are defined in 'XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004' which is aligned with ISO 8601. Note on the time format:

  1. beginning / end of calendar day 00:00:00 = the beginning of a calendar day 24:00:00 = the end of a calendar day
  2. fractions of second in time format Decimal fractions of seconds may be included. In this case, the involved parties shall agree on the maximum number of digits that are allowed.
number_of_transactions
required
string (Max15NumericText) [ 1 .. 15 ] characters ^[0-9]{1,15}$
control_sum
string (DecimalNumber) [ 1 .. 19 ] characters
initiating_party_name
required
string (Max140Text) [ 1 .. 140 ] characters

Specifies a character string with a maximum length of 140 characters.

initiating_party_bic
string (AnyBICIdentifier) ^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3})...

Code allocated to organisations by the ISO 9362 Registration Authority, under an international identification scheme, as described in the latest version of the standard ISO 9362 Banking (Banking telecommunication messages, Bank Identifier Codes).

initiating_party_identification
string (Max35Text) [ 1 .. 35 ] characters
required
Array of objects non-empty

Information related to the individual payments with a single API submission.

{
  • "summary": "AU CBFT payment initiation example",
  • "value": {
    }
}