Paths
/personal-loan-offers-v2
Get personal loan offers
Get personal loan offers
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
Loan amount that user is interested in applying for.
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Loan Offers resource successfully retrieved
{
"schema": {
"type": "object",
"required": [
"PersonalLoanOffers",
"Links",
"Meta"
],
"properties": {
"PersonalLoanOffers": {
"$ref": "#\/definitions\/PersonalLoanOffers"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Metadata"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}
Get personal loan offer detail
Get personal loan offer details
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
The unique id of the offer
requested loan amount
desired loan term (used for recalculation)
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Loan Offers resource successfully retrieved
{
"schema": {
"type": "object",
"required": [
"PersonalLoanOffers",
"Links",
"Meta"
],
"properties": {
"PersonalLoanOffers": {
"$ref": "#\/definitions\/PersonalLoanOffers"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Metadata"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}/financials
Get customer financial information
Get customer financial information
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
Unique identification as assigned by the ASPSP to uniquely identify the customer financial information.
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Customer Financials successfully retrieved
{
"schema": {
"type": "object",
"required": [
"CustomerFinancials",
"Links",
"Meta"
],
"properties": {
"CustomerFinancials": {
"$ref": "#\/definitions\/CustomerFinancials"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Metadata"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-v2
Accept personal loan offer to create personal-loan
Accept personal loan offer to create personal-loan
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
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
cc309236
A loan offer accepted
{
"schema": {
"type": "object",
"required": [
"PersonalLoanId",
"Links",
"Meta",
"PLStatus",
"PLOfferId"
],
"properties": {
"PersonalLoanId": {
"$ref": "#\/definitions\/PersonalLoan"
},
"PLStatus": {
"type": "string",
"example": "string"
},
"PLOfferId": {
"type": "string",
"example": "string"
},
"Links": {
"$ref": "#\/definitions\/Links"
},
"Meta": {
"$ref": "#\/definitions\/Metadata"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "strinBad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}/dispute
Get dispute
Get dispute
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
The unique id of the offer
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Offer Id Disputes
{
"schema": {
"type": "object",
"required": [
"Label",
"Description",
"Reasons"
],
"properties": {
"Label": {
"type": "string",
"example": "label"
},
"Description": {
"type": "string",
"example": "desription"
},
"Reasons": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ReasonsData"
}
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}/updatedispute
Update dispute
Update dispute
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
The unique id of the offer
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
cc309236
A dispute was posted
{
"schema": {
"type": "object",
"properties": {
"Status": {
"$ref": "#\/definitions\/Status"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}/dropoff
Get dropoff
Get dropoff
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
The unique id of the offer
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
Offer Id Disputes
{
"schema": {
"type": "object",
"required": [
"Label",
"Description",
"Reasons"
],
"properties": {
"Label": {
"type": "string",
"example": "label"
},
"Description": {
"type": "string",
"example": "desription"
},
"Reasons": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ReasonsData"
}
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
/personal-loan-offers-v2/{offerId}/updatedropoff
Update dropoff
Update dropoff
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
The unique id of the offer
The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
The time when the PSU last logged in with the TPP.
The PSU's IP address if the PSU is currently logged in with the TPP.
An RFC4122 UID used as a correlation id.
An Authorisation Token as per https://tools.ietf.org/html/rfc6750
cc309236
A dispute was posted
{
"schema": {
"type": "object",
"properties": {
"Status": {
"$ref": "#\/definitions\/Status"
}
}
},
"headers": {
"x-jws-signature": {
"type": "string",
"description": "Header containing a detached JWS signature of the body of the payload. (For future use)"
},
"x-fapi-interaction-id": {
"type": "string",
"description": "An RFC4122 UID used as a correlation id."
}
}
}Bad Request
Unauthorized
Forbidden
Too Many Requests
Internal Server Error
Definitions
{
"type": "string",
"enum": [
"Success",
"Failed"
],
"example": "Success"
}
{
"required": [
"Label",
"Description",
"Reasons"
],
"properties": {
"Label": {
"type": "string",
"example": "label"
},
"Description": {
"type": "string",
"example": "desription"
},
"Reasons": {
"type": "array",
"items": {
"$ref": "#/definitions/ReasonsData"
}
}
}
}
{
"required": [
"Id",
"Label",
"Selected"
],
"properties": {
"Id": {
"type": "string"
},
"Label": {
"type": "string"
},
"Description": {
"type": "string"
},
"Selected": {
"type": "boolean",
"example": false
},
"Exclusive": {
"type": "boolean",
"example": false
},
"More": {
"type": "boolean",
"example": false
}
}
}
{
"type": "string"
}
{
"type": "object",
"properties": {
"Amount": {
"type": "number",
"example": 4499.95
},
"Currency": {
"type": "string",
"enum": [
"ZAR"
],
"example": "ZAR"
}
},
"required": [
"Amount",
"Currency"
]
}
{
"properties": {
"Amount": {
"$ref": "#/definitions/Amount"
},
"Label": {
"type": "string",
"example": "Loan Amount"
},
"Description": {
"type": "string",
"example": "Here is your offer as previliged nedbank user."
}
}
}
{
"properties": {
"Rate": {
"type": "number",
"example": 8
},
"Label": {
"type": "string",
"example": "Interest Rate"
},
"Description": {
"type": "string",
"example": "Interest Rate"
},
"Help": {
"type": "string",
"example": "http://help/help"
}
},
"required": [
"Rate"
]
}
{
"required": [
"OptionsId",
"Label"
],
"properties": {
"OptionsId": {
"type": "string",
"example": "1"
},
"Label": {
"type": "string",
"example": ""
}
}
}
{
"required": [
"Options",
"Selected"
],
"properties": {
"Options": {
"type": "array",
"items": {
"$ref": "#/definitions/Options"
}
},
"Selected": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"DisclosureDetailId",
"Label",
"Options",
"Selected"
],
"properties": {
"DisclosureDetailId": {
"type": "string",
"example": "1"
},
"Label": {
"type": "string",
"example": ""
},
"Description": {
"type": "string",
"example": ""
},
"Options": {
"type": "array",
"items": {
"$ref": "#/definitions/Options"
}
},
"Selected": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"Disclaimerid",
"DisclaimerLabel",
"Accepted"
],
"properties": {
"Disclaimerid": {
"type": "string",
"example": "1"
},
"DisclaimerLabel": {
"type": "string",
"example": "You are permanently employed"
},
"Accepted": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"Label",
"Accepted"
],
"properties": {
"Label": {
"type": "string",
"example": "Click here to view your terms and conditions"
},
"Url": {
"type": "string",
"example": "http://termsandconditions.com/tnc"
},
"Accepted": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"Term",
"MaxAmount",
"MinAmount",
"InterestRate",
"Preferred"
],
"properties": {
"Term": {
"type": "number",
"example": 12
},
"MaxAmount": {
"$ref": "#/definitions/Amount"
},
"MinAmount": {
"$ref": "#/definitions/Amount"
},
"InterestRate": {
"$ref": "#/definitions/Rate"
},
"RepaymentInstalment": {
"$ref": "#/definitions/Amount"
},
"Preferred": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"TotalLoanAmount"
],
"properties": {
"InitiationFee": {
"$ref": "#/definitions/NBAmount"
},
"CostMultiplier": {
"$ref": "#/definitions/Rate"
},
"TotalLoanAmount": {
"$ref": "#/definitions/NBAmount"
},
"LoanAmount": {
"$ref": "#/definitions/NBAmount"
},
"NumberOfInstallments": {
"$ref": "#/definitions/Rate"
},
"FixedInterestRate": {
"$ref": "#/definitions/Rate"
}
}
}
{
"required": [
"BaseRepaymentAmount",
"TotalMonthlyRepayment"
],
"properties": {
"CreditLife": {
"$ref": "#/definitions/NBAmount"
},
"ServiceFee": {
"$ref": "#/definitions/NBAmount"
},
"BaseRepaymentAmount": {
"$ref": "#/definitions/NBAmount"
},
"TotalMonthlyRepayment": {
"$ref": "#/definitions/NBAmount"
},
"TotalAmountRepayable": {
"$ref": "#/definitions/NBAmount"
}
}
}
{
"required": [
"DiscountTotalMonthlyRepayment",
"DiscountInterestRate",
"LoanDetails",
"RepaymentDetails"
],
"properties": {
"DiscountTotalMonthlyRepayment": {
"$ref": "#/definitions/NBAmount"
},
"DiscountInterestRate": {
"$ref": "#/definitions/Rate"
},
"LoanDetails": {
"$ref": "#/definitions/LoanDetails"
},
"RepaymentDetails": {
"$ref": "#/definitions/RepaymentDetails"
}
}
}
{
"required": [
"Disclaimers"
],
"properties": {
"DataLabels": {
"type": "array",
"items": {
"type": "string"
}
},
"Disclaimers": {
"type": "array",
"items": {
"$ref": "#/definitions/DisclaimerDetails"
}
}
}
}
{
"required": [
"DisclosureDetails",
"Accepted"
],
"properties": {
"DisclosureDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/DisclosureDetails"
}
},
"Purpose": {
"$ref": "#/definitions/Purpose"
},
"Email": {
"type": "string",
"example": "nedbank@nedbank.com"
},
"Accepted": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"PLOfferId",
"Terms"
],
"properties": {
"PLOfferId": {
"type": "string",
"example": 123
},
"Terms": {
"type": "array",
"items": {
"$ref": "#/definitions/LoanTerm"
}
},
"LoanDetails": {
"$ref": "#/definitions/LoanDetails"
},
"RepaymentDetails": {
"$ref": "#/definitions/RepaymentDetails"
},
"DiscountRepaymentDetails": {
"$ref": "#/definitions/DiscountRepaymentDetails"
},
"Disclaimers": {
"$ref": "#/definitions/Disclaimers"
},
"Disclosures": {
"$ref": "#/definitions/Disclosures"
},
"TermsAndConditions": {
"$ref": "#/definitions/TermsAndConditions"
},
"Financials": {
"$ref": "#/definitions/Financials"
},
"CreditInsuranceLink": {
"type": "string",
"example": "https://www.nedbank.co.za/content/dam/nedbank/site-assets/Personal/Personal_Loans/Insurance/InsuranceBrochure.pdf"
},
"ExclusionLink": {
"type": "string",
"example": "https://www.nedbank.co.za/content/dam/nedbank/site-assets/Personal/Personal_Loans/Insurance/Policydocument.pdf"
},
"InsuranceAccepted": {
"type": "boolean",
"example": false
},
"IsNedbankStaff": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"Label"
],
"properties": {
"Label": {
"type": "string",
"example": "Total monthly living expenses"
},
"Description": {
"type": "string",
"example": "living expenses"
},
"Amount": {
"$ref": "#/definitions/Amount"
}
}
}
{
"required": [
"Declarations",
"Accepted"
],
"properties": {
"Declarations": {
"type": "array",
"items": {
"$ref": "#/definitions/Declarations"
}
},
"Accepted": {
"type": "boolean",
"example": false
}
}
}
{
"required": [
"Financials",
"Accepted"
],
"properties": {
"Financials": {
"$ref": "#/definitions/Financials"
}
}
}
{
"required": [
"PLOffer"
],
"properties": {
"PLOfferId": {
"type": "string",
"example": 4
},
"PLOffer": {
"$ref": "#/definitions/PersonalLoanOffers"
}
}
}
{
"required": [
"self"
],
"properties": {
"self": {
"type": "string",
"example": "http://localhost:3000/api/open-banking/v1/self-resource"
},
"first": {
"type": "string",
"example": "http://localhost:3000/api/open-banking/v1/first-resource"
},
"next": {
"type": "string",
"example": "http://localhost:3000/api/open-banking/v1/next-resource"
},
"prev": {
"type": "string",
"example": "http://localhost:3000/api/open-banking/v1/prev-resource"
}
}
}
{
"properties": {
"total-pages": {
"type": "string",
"example": 1
}
}
}