Implementation guidance:
- Once this change is rolled out, merchants that have not been fully verified will not be able perform the following actions or use these endpoints:
- The endpoints above will return the following API error message:
1 {
2 "error": {
3 "code": 403,
4 "type": "invalid_api_usage",
5 "errors": [
6 {
7 "reason": "creditor_not_fully_verified",
8 "message": "Creditor account not fully verified"
9 }
10 ],
11 "message": "Creditor account not fully verified",
12 "request_id": SOME_REQUEST_ID
13 }
14}
- GoCardless recommends that you display the following error message to users:
- Error: This payment could not be created because you need to verify your GoCardless account. Verify now [url]
- GoCardless will send the following email to users:
- The GoCardless dashboard will also have these actions restricted from merchants that are not fully verified.
Testing Implementation in the sandbox environment
Partners and Integrators can test this behaviour change using the scenario simulator (via the api, or via the dashboard) in the sandbox environment
By using the scenario simulator to change the creditor’s verification status to “in review“ or “action required“, the creditor will then be restricted from payment creation. For reference, that’s the creditor_verification_status_in_review
scenario and creditor_verification_status_action_required
scenario in the scenario simulator endpoint.
Example request, for the creditor_verification_status_in_review
scenario:
1 POST https://api-sandbox.gocardless.com/scenario_simulators/creditor_verification_status_in_review/actions/run HTTP/1.1
2 {
3 "data": {
4 "links": {
5 "resource": "INSERT-CREDITOR-ID"
6 }
7 }
8 }
Once testing is completion, you can use the scenario simulator to revert the verification status back to successful, i.e. the creditor_verification_status_successful
scenario.
If you have any questions or require further guidance please don’t hesitate to contact us at partnerships@gocardless.com