production
https://api.nedbank.co.za/apimarket/sandbox
Paths
/customer-requests
post /customer-requests
Create an customer request
Create an customer request
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
tpp_client_credential
TPP Client Credential Scope
X-IBM-Client-Secret
X-IBM-Client-Secret
(apiKey located in header)
X-IBM-Client-Id
X-IBM-Client-Id
(apiKey located in header)
body
Required in body
object
Create an Customer Request
{
"schema": {
"title": "Customer Request POST request",
"description": "Allows setup of an customer access request",
"type": "object",
"properties": {
"Data": {
"title": "Data",
"description": "Allows setup of an customer access request",
"type": "object",
"properties": {
"Permissions": {
"description": "Specifies the customer request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.",
"type": "array",
"items": {
"description": "Specifies the customer request types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP.",
"type": "string",
"enum": [
"ReadCustomersBasic",
"ReadCustomersDetail"
]
},
"minProperties": 1,
"additionalProperties": false
},
"ExpirationDateTime": {
"description": "Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended.",
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false,
"required": [
"Permissions"
]
},
"Risk": {
"title": "Risk",
"type": "object",
"description": "The Risk payload is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Customer Info.",
"properties": [],
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"Data",
"Risk"
]
}
}x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
Optional in header
string
The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
201
Customer Request resource successfully created
{
"schema": {
"title": "Customer Request POST response",
"type": "object",
"properties": {
"Data": {
"title": "Data",
"type": "object",
"properties": {
"CustomerRequestId": {
"description": "Unique identification as assigned to identify the customer request resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Status": {
"description": "Specifies the status of the customer request resource.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Rejected",
"Revoked"
]
},
"Crea400
Bad Request
401
Unauthorized
403
Forbidden
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
POST https://api.nedbank.co.za/apimarket/sandbox/open-banking/customer-requests
Try this operation
/customer-requests/{CustomerRequestId}
get /customer-requests/{CustomerRequestId}
Get an customer request
Get an customer request
TPPOAuth2Security
TPPOAuth2Security
(oauth2 application)
TPP client credential authorisation flow with the ASPSP
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
tpp_client_credential
TPP Client Credential Scope
X-IBM-Client-Secret
X-IBM-Client-Secret
(apiKey located in header)
X-IBM-Client-Id
X-IBM-Client-Id
(apiKey located in header)
CustomerRequestId
Required in path
string
Unique identification as assigned by the ASPSP to uniquely identify the customer request resource.
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
Optional in header
string
The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Accept
Optional in header
string
application/json
200
Customer Request resource successfully retrieved
{
"schema": {
"title": "Customer Request GET response",
"type": "object",
"properties": {
"Data": {
"title": "Data",
"type": "object",
"properties": {
"CustomerRequestId": {
"description": "Unique identification as assigned to identify the customer request resource.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"Status": {
"description": "Specifies the status of the customer request resource.",
"type": "string",
"enum": [
"Authorised",
"AwaitingAuthorisation",
"Rejected",
"Revoked"
]
},
"Creat400
Bad Request
401
Unauthorized
403
Forbidden
429
Too Many Requests
500
Internal Server Error
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/customer-requests/{CustomerRequestId}
Try this operation
/customers
get /customers
Gets the customer details
PSUOAuth2Security
PSUOAuth2Security
(oauth2 accessCode)
OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
Authorization URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/authorize
Token URL
https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token
Scopes
customers
Ability to read customers information
openid
X-IBM-Client-Secret
X-IBM-Client-Secret
(apiKey located in header)
X-IBM-Client-Id
X-IBM-Client-Id
(apiKey located in header)
x-fapi-financial-id
Required in header
string
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
x-fapi-customer-last-logged-time
Optional in header
string
The time when the PSU last logged in with the TPP.
x-fapi-customer-ip-address
Optional in header
string
The PSU's IP address if the PSU is currently logged in with the TPP.
x-fapi-interaction-id
Optional in header
string
An RFC4122 UID used as a correlation id.
authorization
Required in header
string
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Accept
Optional in header
string
application/json
200
Successful response
401
Unauthorized
Example Request
Example Response
GET https://api.nedbank.co.za/apimarket/sandbox/open-banking/customers
Try this operation
Definitions
{
"title": "Customer GET response",
"type": "object",
"properties": {
"Data": {
"title": "Transaction",
"description": "Data Section of the Payload",
"type": "array",
"items": {
"type": "object",
"properties": {
"FirstName": {
"type": "string",
"description": "The client first name"
},
"MiddleName": {
"type": "string",
"description": "The client middle name"
},
"LastName": {
"type": "string",
"description": "The client last name"
},
"FullName": {
"type": "string",
"description": "The client full name"
},
"BirthDate": {
"type": "string",
"format": "date",
"description": "The client BirthDate"
},
"Email": {
"type": "string",
"description": "The client email address"
},
"Identity": {
"type": "array",
"items": {
"$ref": "#/definitions/IdentityItem"
}
},
"Contact": {
"type": "array",
"items": {
"$ref": "#/definitions/AdditionalPhoneItem"
}
},
"Compliance": {
"type": "array",
"items": {
"$ref": "#/definitions/ComplianceItem"
}
},
"Address": {
"$ref": "#/definitions/AddressItem"
},
"Links": {
"$ref": "#/definitions/LinkItem"
},
"Meta": {
"$ref": "#/definitions/MetaItem"
}
}
}
}
}
}
{
"properties": {
"Type": {
"type": "string"
},
"Line": {
"type": "array",
"items": {
"type": "string"
},
"description": "The address line"
},
"City": {
"type": "string",
"description": "The city"
},
"PostalCode": {
"type": "string",
"description": "The postal code"
},
"Province": {
"type": "string",
"description": "The province"
},
"Country": {
"type": "string",
"description": "The country"
}
}
}
{
"properties": {
"AddressLine": {
"type": "string",
"description": "The address line"
}
}
}
{
"properties": {
"Type": {
"type": "string",
"description": "The contact type (Cell,Email,Bus,Fax)"
},
"Value": {
"type": "string",
"description": "The contact value"
}
}
}
{
"properties": {
"Type": {
"type": "string",
"description": "The compliance type (Fica)"
},
"Value": {
"type": "string",
"description": "The compliance value"
}
}
}
{
"properties": {
"Type": {
"type": "string",
"description": "The identity type (Id,Tax,Passport)",
"enum": [
"Id",
"Tax",
"Passport"
]
},
"Identification": {
"type": "string",
"description": "The identification number"
}
}
}
{
"properties": {
"self": {
"type": "string",
"format": "uri"
},
"first": {
"type": "string",
"format": "uri"
},
"prev": {
"type": "string",
"format": "uri"
},
"next": {
"type": "string",
"format": "uri"
},
"last": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
Meta Data relevant to the payload
{
"title": "Meta Data",
"type": "object",
"properties": {
"total-pages": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}