{"openapi":"3.0.0","info":{"description":"","title":"Payee Account Check","version":"1.0.1","x-api-id":"92c46bdc-6b44-4e99-92ae-65c383b10ad9","x-audience":"company-internal","x-ibm-name":"payee-account-check"},"servers":[{"url":"https://api.rabobank.nl/openapi/spv","description":"Production server"},{"url":"https://api-sandbox.rabobank.nl/openapi/sandbox/spv","description":"Sandbox server"}],"paths":{"/payments/single-payee-verification":{"post":{"parameters":[{"description":"ID of the request, unique to the call, as determined by the initiating party.","example":"e9c96b7e-8470-410a-937c-396fe9512fea","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Standard https header element with date, time and timezone.","example":"Thu, 18 Mar 2021 15:10:46 GMT","in":"header","name":"Date","required":true,"schema":{"type":"string"}},{"description":"Public certificate of the Initiating Party that corresponds with the signature made by the Initiating Party.","example":"MIIDkDCCAnigAwIBAgIEWs3AJDANBgkqhkiG9w0BAQsFADCBiTELMAkGA1UEBhMCTkwxEDAOBgNVBAgMB1V0cmVjaHQxEDAOBgNVBAcMB1V0cmVjaHQxETAPBgNVBAoMCFJhYm9iYW5rMRwwGgYDVQQLDBNPbmxpbmUgVHJhbnNhY3Rpb25zMSUwIwYDVQQDDBxQU0QyIEFQSSBQSSBTZXJ2aWNlcyBTYW5kYm94MB4XDTE4MDQxMTA3NTgyOFoXDTIzMDQxMTA3NTgyOFowgYkxCzAJBgNVBAYTAk5MMRAwDgYDVQQIDAdVdHJlY2h0MRAwDgYDVQQHDAdVdHJlY2h0MREwDwYDVQQKDAhSYWJvYmFuazEcMBoGA1UECwwTT25saW5lIFRyYW5zYWN0aW9uczElMCMGA1UEAwwcUFNEMiBBUEkgUEkgU2VydmljZXMgU2FuZGJveDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANoAjqGWUgCIm2F+0sBSEwLal+T3u+uldLikpxHCB8iL1GD7FrRjcA+MVsxhvHly7vRsHK+tQyMSaeK782RHpY33qxPLc8LmoQLb2EuiQxXj9POYkYBQ74qkrZnvKVlR3WoyQWeDOXnSY2wbNFfkP8ET4ElwyuIIEriwYhab0OIrnnrO8X82/SPZxHwEd3aQjQ6uhiw8paDspJbS5WjEfuwY16KVVUYlhbtAwGjvc6aK0NBm+LH9fMLpAE6gfGZNy0gzMDorVNbkQK1IoAGD8p9ZHdB0F3FwkILEjUiQW6nK+/fKDNJ0TBbpgZUpY8bR460qzxKdeZ1yPDqX2Cjh6fkCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAYL4iD6noMJAt63kDED4RB2mII/lssvHhcxuDpOm3Ims9urubFWEpvV5TgIBAxy9PBinOdjhO1kGJJnYi7F1jv1qnZwTV1JhYbvxv3+vk0jaiu7Ew7G3ASlzruXyMhN6t6jk9MpaWGl5Uw1T+gNRUcWQRR44g3ahQRIS/UHkaV+vcpOa8j186/1X0ULHfbcVQk4LMmJeXqNs8sBAUdKU/c6ssvj8jfJ4SfrurcBhY5UBTOdQOXTPY85aU3iFloerx7Oi9EHewxInOrU5XzqqTz2AQPXezexVeAQxP27lzqCmYC7CFiam6QBr06VebkmnPLfs76n8CDc1cwE6gUl0rMA==","in":"header","name":"Signature-Certificate","required":true,"schema":{"type":"string"}},{"description":"The forwarded IP Address header field consists of the corresponding http request IP Address field of the Initiating Party.","example":"192.68.1.1","in":"header","name":"PSU-IP-Address","required":true,"schema":{"type":"string"}},{"description":"Content type of the request (application/json).","example":"application/json","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},{"description":"Signature is made up of the headers: date, digest and x-request-id. For more information see additional documentation in portal.","example":"keyId=\"1523433508\",algorithm=\"rsa-sha512\",headers=\"date digest x-request-id\",signature=\"orkASK4HiryOEbTPQ52l0SD1cAjDpSZUbLdaiE5JYGDl1wv1fcXiKvKOa4nitZ4LsDctwA7cnpEkzv1XBAqy5uvggwKuZCjDbk9u5c5Sox9kzXgojLhcIcGlUXRmcTzDQl64kW6Hr6deTCOBzGmEQbdXmSWEsiQwp4bOIlhrw1iKN3PrAqN7tEFuEPn1VkK3XGoaD7DyBkAOANdjUgU9wg1c/5OAKZfzttoUXC1PzbzFnIkOVPIWG+1FidFSTcR+M07wwlZSbcx6XhSChRCM3Qpr3LvIGi+j8+eL6DsHEfbHb3sg1Zo4EreadKuwzfYuOMiYl+e6meyN2GWAVMLKYA==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},{"description":"The digest is a base64 encoded hash of the body.(SHA-512 or SHA-256 is allowed)","example":"sha-512=adwckzJ1AFNfnFKZ2dmi//4R+6ELVVWtDIKbQzVIldiDMZY3e97ZoVXAhFJUGpdgckRhQT0JYVcLgbtkex7jLQ==","in":"header","name":"Digest","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"result":{"resultType":"MATCHING"}}}},"schema":{"$ref":"#/components/schemas/SinglePayeeResponse"}}},"description":"The status of the payment order of the initiating party is found and returned","headers":{"X-Request-ID":{"description":"ID of the request, unique to the call, as determined by the initiating party.","schema":{"format":"uuid","type":"string"},"x-example":"e9c96b7e-8470-410a-937c-396fe9512fea"}}},"400":{"content":{"application/json":{"examples":{"response":{"value":{"messages":[{"category":"ERROR","code":"FORMAT_ERROR","path":"account.name","text":"size must be between 0 and 70"}]}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorised"},"405":{"content":{"application/json":{"examples":{"response":{"value":{"messages":[{"category":"ERROR","code":"PAYMENT_FAILED","path":"/spv/payments/single-payee-verification","text":"Request method 'POST' not supported"}]}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Method Not Allowed"},"500":{"content":{"application/json":{"examples":{"response":{"value":{"messages":[{"category":"ERROR","code":"PAYEE_VERIFICATION_FAILED","text":"Unable to verify the payee"}]}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"},"503":{"description":"Service Unavailable"}},"description":"This API can be used to verify the name and IBAN of the beneficiary.","operationId":"Verify Payee Information","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SinglePayeeRequest"}}},"required":true},"summary":"Verify name and IBAN of the beneficiary"}}},"components":{"parameters":{"contentType":{"description":"Content type of the request (application/json).","example":"application/json","in":"header","name":"Content-Type","required":true,"schema":{"type":"string"}},"date":{"description":"Standard https header element with date, time and timezone.","example":"Thu, 18 Mar 2021 15:10:46 GMT","in":"header","name":"Date","required":true,"schema":{"type":"string"}},"digest":{"description":"The digest is a base64 encoded hash of the body.(SHA-512 or SHA-256 is allowed)","example":"sha-512=adwckzJ1AFNfnFKZ2dmi//4R+6ELVVWtDIKbQzVIldiDMZY3e97ZoVXAhFJUGpdgckRhQT0JYVcLgbtkex7jLQ==","in":"header","name":"Digest","required":true,"schema":{"type":"string"}},"psuIpAddress":{"description":"The forwarded IP Address header field consists of the corresponding http request IP Address field of the Initiating Party.","example":"192.68.1.1","in":"header","name":"PSU-IP-Address","required":true,"schema":{"type":"string"}},"signature":{"description":"Signature is made up of the headers: date, digest and x-request-id. For more information see additional documentation in portal.","example":"keyId=\"1523433508\",algorithm=\"rsa-sha512\",headers=\"date digest x-request-id\",signature=\"orkASK4HiryOEbTPQ52l0SD1cAjDpSZUbLdaiE5JYGDl1wv1fcXiKvKOa4nitZ4LsDctwA7cnpEkzv1XBAqy5uvggwKuZCjDbk9u5c5Sox9kzXgojLhcIcGlUXRmcTzDQl64kW6Hr6deTCOBzGmEQbdXmSWEsiQwp4bOIlhrw1iKN3PrAqN7tEFuEPn1VkK3XGoaD7DyBkAOANdjUgU9wg1c/5OAKZfzttoUXC1PzbzFnIkOVPIWG+1FidFSTcR+M07wwlZSbcx6XhSChRCM3Qpr3LvIGi+j8+eL6DsHEfbHb3sg1Zo4EreadKuwzfYuOMiYl+e6meyN2GWAVMLKYA==\"","in":"header","name":"Signature","required":true,"schema":{"type":"string"}},"signatureCertificate":{"description":"Public certificate of the Initiating Party that corresponds with the signature made by the Initiating Party.","example":"MIIDkDCCAnigAwIBAgIEWs3AJDANBgkqhkiG9w0BAQsFADCBiTELMAkGA1UEBhMCTkwxEDAOBgNVBAgMB1V0cmVjaHQxEDAOBgNVBAcMB1V0cmVjaHQxETAPBgNVBAoMCFJhYm9iYW5rMRwwGgYDVQQLDBNPbmxpbmUgVHJhbnNhY3Rpb25zMSUwIwYDVQQDDBxQU0QyIEFQSSBQSSBTZXJ2aWNlcyBTYW5kYm94MB4XDTE4MDQxMTA3NTgyOFoXDTIzMDQxMTA3NTgyOFowgYkxCzAJBgNVBAYTAk5MMRAwDgYDVQQIDAdVdHJlY2h0MRAwDgYDVQQHDAdVdHJlY2h0MREwDwYDVQQKDAhSYWJvYmFuazEcMBoGA1UECwwTT25saW5lIFRyYW5zYWN0aW9uczElMCMGA1UEAwwcUFNEMiBBUEkgUEkgU2VydmljZXMgU2FuZGJveDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANoAjqGWUgCIm2F+0sBSEwLal+T3u+uldLikpxHCB8iL1GD7FrRjcA+MVsxhvHly7vRsHK+tQyMSaeK782RHpY33qxPLc8LmoQLb2EuiQxXj9POYkYBQ74qkrZnvKVlR3WoyQWeDOXnSY2wbNFfkP8ET4ElwyuIIEriwYhab0OIrnnrO8X82/SPZxHwEd3aQjQ6uhiw8paDspJbS5WjEfuwY16KVVUYlhbtAwGjvc6aK0NBm+LH9fMLpAE6gfGZNy0gzMDorVNbkQK1IoAGD8p9ZHdB0F3FwkILEjUiQW6nK+/fKDNJ0TBbpgZUpY8bR460qzxKdeZ1yPDqX2Cjh6fkCAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAYL4iD6noMJAt63kDED4RB2mII/lssvHhcxuDpOm3Ims9urubFWEpvV5TgIBAxy9PBinOdjhO1kGJJnYi7F1jv1qnZwTV1JhYbvxv3+vk0jaiu7Ew7G3ASlzruXyMhN6t6jk9MpaWGl5Uw1T+gNRUcWQRR44g3ahQRIS/UHkaV+vcpOa8j186/1X0ULHfbcVQk4LMmJeXqNs8sBAUdKU/c6ssvj8jfJ4SfrurcBhY5UBTOdQOXTPY85aU3iFloerx7Oi9EHewxInOrU5XzqqTz2AQPXezexVeAQxP27lzqCmYC7CFiam6QBr06VebkmnPLfs76n8CDc1cwE6gUl0rMA==","in":"header","name":"Signature-Certificate","required":true,"schema":{"type":"string"}},"xRequestId":{"description":"ID of the request, unique to the call, as determined by the initiating party.","example":"e9c96b7e-8470-410a-937c-396fe9512fea","in":"header","name":"X-Request-ID","required":true,"schema":{"format":"uuid","type":"string"}}},"schemas":{"AccountIdentification":{"description":"Account Details.","properties":{"name":{"description":"Name of the account holder, as filled in by the end user","example":"Allen Martin","maxLength":70,"minLength":0,"type":"string"},"type":{"description":"IBAN/EMAIL/PHONE","example":"IBAN","type":"string"},"value":{"description":"The identifier of the account to be checked","example":"NL60RABO159349508","maxLength":140,"minLength":0,"type":"string"}},"required":["name","value"],"type":"object"},"ErrorResponse":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/MessageInformation"},"type":"array"}},"required":["messages"],"type":"object"},"MessageInformation":{"properties":{"category":{"description":"Indicates the type of the information.","enum":["ERROR","WARNING"],"example":"ERROR","type":"string"},"code":{"description":"Gives details about what to do next or indicates the reason of the request message or a data element requested.","enum":["CERTIFICATE_INVALID","CERTIFICATE_EXPIRED","CERTIFICATE_BLOCKED","CERTIFICATE_REVOKED","CERTIFICATE_MISSING","SIGNATURE_INVALID","SIGNATURE_MISSING","FORMAT_ERROR","UNKNOWN","PAYEE_VERIFICATION_FAILED","TECHNICAL_ERROR","CONSENT_UNKNOWN"],"example":"SIGNATURE_INVALID","type":"string"},"path":{"description":"Indicates data element of the request message or a data element requested.","example":"Signature","type":"string"},"text":{"description":"A message regarding the data element requested.","example":"Signature is invalid.","maxLength":512,"minLength":2,"type":"string"}},"required":["category","code"],"type":"object"},"ResultResponse":{"properties":{"nameSuggestion":{"description":"In case the source has determined that the provided name closely resembles the account holder name.","type":"string"},"resultSubCode":{"description":"Contains more details on the why there it is a no match","type":"string"},"resultType":{"description":"Describes the result of the account name check.","enum":["MATCHING","NOT_MATCHING","CLOSE_MATCH","INVALID_NAME_LENGTH","IBAN_UNKNOWN","ID_OR_NAME_NOT_PROVIDED","INVALID_CORRELATION_ID","INVALID_NAME","ACCOUNT_INACTIVE"],"type":"string"}},"required":["resultType"],"type":"object"},"SinglePayeeRequest":{"description":"Single Payee Verification information.","properties":{"account":{"$ref":"#/components/schemas/AccountIdentification"}},"required":["account"],"type":"object"},"SinglePayeeResponse":{"properties":{"result":{"$ref":"#/components/schemas/ResultResponse"}},"type":"object"}},"securitySchemes":{"clientId":{"description":"ClientId as provided by the Rabobank developer portal.","in":"header","name":"X-IBM-Client-Id","type":"apiKey"},"oauth2_premium_access_code_flow_verification-of-payee":{"description":"NOTE Please use the Authorization and Token URL as provided by the oAuth2 Services. Scope: bip.payments.write","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.rabobank.nl/openapi/oauth2-premium/authorize","scopes":{"bip.payments.write":"Payments from your payment account"},"tokenUrl":"https://oauth.rabobank.nl/openapi/oauth2-premium/token"}},"type":"oauth2","x-ibm-oauth-provider":"access-authorization-1-0-0-8e24"}}},"security":[{"clientId":[],"oauth2_premium_access_code_flow_verification-of-payee":["bip.payments.write"]}],"x-readme":{"explorer-enabled":false,"proxy-enabled":false}}