{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/partners.staging.goescrow.net" } ], "info": { "name": "GoEscrow API Documentation", "_postman_id": "6650ecb3-f1b9-4883-9522-50524dadc25b", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "System", "description": "", "item": [ { "name": "GET api\/v1\/healthcheck", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/healthcheck", "query": [], "raw": "{{baseUrl}}\/api\/v1\/healthcheck" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Company Management", "description": "Manage Companies", "item": [ { "name": "Lookup a company by ABN", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/lookup", "query": [ { "key": "abn", "value": "40 650 703 736", "description": "The Australian Business Number. Formatting spaces are accepted. For an international company, the INT-- identifier it was created with.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/lookup?abn=40%20650%20703%20736" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Looks up an existing company by Australian Business Number, or by the INT- identifier of an international company. Access is limited to companies represented by a user belonging to the authenticated partner, unless using an internal API key." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"40650703736\",\"acn\":\"004085616\",\"kyb_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"bank_verified\":true,\"abr_status\":\"Active\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "Company found" }, { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345680\",\"reference\":\"DEF456\",\"name\":\"Example Trading Pte Ltd\",\"abn\":\"INT-SG-201912345K\",\"acn\":null,\"kyb_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"bank_verified\":false,\"abr_status\":\"International\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "International company found" }, { "header": [], "code": 404, "body": "{\"message\":\"Company not found or access denied.\"}", "name": "Company not found or access denied" } ] }, { "name": "Create a new company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"40650703736\",\"acn\":\"004085616\",\"email\":\"info@acmecorp.com.au\",\"phone\":\"+61298765432\",\"website\":\"https:\\\/\\\/www.acmecorp.com.au\",\"type\":\"Proprietary Limited\",\"majority_owned_by_another_australian_company\":false,\"majority_owned_by_overseas_person_or_company\":false,\"majority_owned_by_listed_australian_company\":false,\"acting_as_trustee_for_a_trust\":false,\"representatives\":[\"9d2e5c8a-1234-5678-9abc-def012345678\"],\"address\":{\"unit_number\":\"3\",\"street_number\":\"20\",\"street\":\"Company Street\",\"suburb\":\"Melbourne\",\"state\":\"VIC\",\"postcode\":\"3000\",\"country\":\"Australia\"}}" }, "description": "Creates a new company and attaches one or more existing users as its representatives. An international company without an ABN is created by sending abn as INT--; it is not looked up on the Australian Business Register, so name and address.country are required." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"comp_123\",\"reference\":\"ABC123\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"40650703736\",\"acn\":\"004085616\",\"kyb_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"bank_verified\":true,\"abr_status\":\"Active\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "Company created successfully" }, { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"comp_456\",\"reference\":\"DEF456\",\"name\":\"Example Trading Pte Ltd\",\"abn\":\"INT-SG-201912345K\",\"acn\":null,\"kyb_verified\":false,\"aml_verified\":false,\"aml_verified_at\":null,\"bank_verified\":false,\"abr_status\":\"International\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "International company created successfully" }, { "header": [], "code": 422, "body": "{\"message\":\"The abn for an international company must look like INT-SG-201912345K: INT, a 2-letter country code, then the registration number (letters and digits only). (and 1 more error)\",\"errors\":{\"abn\":[\"The abn for an international company must look like INT-SG-201912345K: INT, a 2-letter country code, then the registration number (letters and digits only).\"],\"address.country\":[\"The address.country field is required.\"]}}", "name": "Validation failed, for example a malformed international identifier or a missing address.country" } ] }, { "name": "Update a company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:id", "variable": [ { "id": "company_id", "key": "company_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The company UUID (36-character internal identifier)" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Acme Corp Pty Ltd\",\"acn\":\"004085616\",\"email\":\"info@acmecorp.com.au\",\"phone\":\"+61298765432\",\"website\":\"https:\\\/\\\/www.acmecorp.com.au\",\"type\":\"Proprietary Limited\",\"majority_owned_by_another_australian_company\":false,\"majority_owned_by_overseas_person_or_company\":false,\"majority_owned_by_listed_australian_company\":false,\"acting_as_trustee_for_a_trust\":false,\"add_representatives\":[\"9d2e5c8a-1234-5678-9abc-def012345678\"],\"remove_representatives\":[\"9d2e5c8a-1234-5678-9abc-def012345679\"],\"address\":{\"unit_number\":\"3\",\"street_number\":\"20\",\"street\":\"Company Street\",\"suburb\":\"Melbourne\",\"state\":\"VIC\",\"postcode\":\"3000\",\"country\":\"Australia\"}}" }, "description": "Updates an existing company. Only provided fields will be updated. ABN must be omitted, even when unchanged; create a new company for a different ABN." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"comp_123\",\"reference\":\"ABC123\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"40650703736\",\"acn\":\"004085616\",\"kyb_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"bank_verified\":true,\"abr_status\":\"Active\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "Company updated successfully" }, { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"comp_456\",\"reference\":\"DEF456\",\"name\":\"Example Trading Pte Ltd\",\"abn\":\"INT-SG-201912345K\",\"acn\":null,\"kyb_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"bank_verified\":false,\"abr_status\":\"International\",\"representatives\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"name\":\"Jane Doe\"}]}}", "name": "International company updated successfully" } ] }, { "name": "Upload company files", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/files", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/files", "variable": [ { "id": "company_id", "key": "company_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The company UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "src": [], "type": "file" } ] }, "description": "Uploads one or more files to a company filing cabinet. The authenticated partner must represent the company." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"file\":\"a1b2c3d4\\\/document.pdf\",\"filename\":\"document.pdf\",\"created_at\":\"2024-01-15T10:30:00Z\"}]}", "name": "Files uploaded" }, { "header": [], "code": 422, "body": "{\"message\":\"Company not found or access denied.\"}", "name": "Not authorised" } ] } ] }, { "name": "Compliance", "description": "Submit compliance evidence collected on your platform", "item": [ { "name": "Record a Fingerprint event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/compliance\/fingerprint-events", "query": [], "raw": "{{baseUrl}}\/api\/v1\/compliance\/fingerprint-events" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"subject\":{\"type\":\"company\",\"id\":\"6f302a63-83af-49df-80d8-c82c62229ce6\"},\"actor\":{\"user_id\":\"2ab54e19-65c2-4f51-a9cc-2145299e6010\"},\"fingerprint\":{\"event_id\":\"1727926800123.Ab12Cd\"},\"context\":{\"action\":\"new_company_account\",\"submission_reference\":\"ABN-20261003-00008\",\"form_type\":\"new_abn_account\",\"occurred_at\":\"2026-10-03T13:40:00+10:00\"}}" }, "description": "Records Fingerprint device evidence for a user or company. Identify the visitor with the GoEscrow Fingerprint browser key when the user submits the action (not on page load: each identification uses GoEscrow's Fingerprint allowance), then send the event ID from your backend. GoEscrow retrieves the event from Fingerprint itself; do not send visitor IDs, IP addresses or signals.\n\nGoEscrow checks that the event was collected on one of your registered origins, is under five minutes old, and has not been used before. A recorded event is evidence for compliance review. It does not verify identity, change device trust, or approve the action it describes.\n\n**Settlement evidence.** If you trigger settlement through the API (a marketplace transaction you operate, or an Anytime or Timed escrow you created), record a `settlement` event when the buyer approves the settlement on your site, then call settle. Send the buyer as the subject (the buyer company, with the buyer representative on the transaction as the actor, for a company buyer) and the transaction in `context.transaction_id`. GoEscrow's settlement risk check uses this event as the buyer's device: a settlement without one, or whose device shows risk signals, is held for compliance review. An event sent after a settlement is held is used when the settlement is rechecked.\n\n**Earlier evidence.** The settlement risk check also asks whether you recorded the buyer's device before. Any earlier event you recorded for the buyer user from the same device counts: account creation, bank account submission, identity document upload, PayTo agreement initiation, or creating a transaction, including the transaction being settled. Settlement events for the same transaction do not count, so retrying an approval cannot make a device familiar. Record `transaction_creation` with the transaction in `context.transaction_id` and the party that created it (buyer or seller) as the subject. Identify the visitor when they submit the transaction, before you create it: an identification taken more than 5 seconds after the transaction was created is rejected.\n\nEach event ID can be recorded once, so retries are safe without an Idempotency-Key. Sending the same event again with the same subject, actor, action, transaction and submission reference returns the original record with `duplicate: true`. Any other reuse returns 409. GoEscrow must register your collection origins before this endpoint can be used.\n\nError responses include a stable `code` and a `retryable` flag. Retry only when `retryable` is true." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"duplicate\":true,\"id\":\"4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\",\"status\":\"recorded\",\"subject\":{\"type\":\"company\",\"id\":\"6f302a63-83af-49df-80d8-c82c62229ce6\"},\"actor\":{\"user_id\":\"2ab54e19-65c2-4f51-a9cc-2145299e6010\"},\"fingerprint\":{\"event_id\":\"1727926800123.Ab12Cd\"},\"action\":\"new_company_account\",\"transaction_id\":null,\"submission_reference\":\"ABN-20261003-00008\",\"recorded_at\":\"2026-10-03T03:40:05.000000Z\"}}", "name": "The same event was already recorded with the same subject, actor, action, transaction and submission reference" }, { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\",\"status\":\"recorded\",\"duplicate\":false,\"subject\":{\"type\":\"company\",\"id\":\"6f302a63-83af-49df-80d8-c82c62229ce6\"},\"actor\":{\"user_id\":\"2ab54e19-65c2-4f51-a9cc-2145299e6010\"},\"fingerprint\":{\"event_id\":\"1727926800123.Ab12Cd\"},\"action\":\"new_company_account\",\"transaction_id\":null,\"submission_reference\":\"ABN-20261003-00008\",\"recorded_at\":\"2026-10-03T03:40:05.000000Z\"}}", "name": "Fingerprint event recorded" }, { "header": [], "code": 403, "body": "{\"message\":\"Fingerprint evidence is not enabled for this partner. Contact GoEscrow to register your collection origins.\",\"code\":\"fingerprint_evidence_not_enabled\",\"retryable\":false}", "name": "No collection origins are registered for this partner" }, { "header": [], "code": 404, "body": "{\"message\":\"Subject not found or access denied.\",\"code\":\"subject_not_found\",\"retryable\":false}", "name": "The subject (subject_not_found), actor (actor_not_found) or transaction (transaction_not_found) does not exist or is not accessible to this partner" }, { "header": [], "code": 409, "body": "{\"message\":\"This Fingerprint event has already been used for a different submission.\",\"code\":\"fingerprint_event_already_assigned\",\"retryable\":false}", "name": "The event was already recorded with a different binding or used for a GoEscrow login (fingerprint_event_already_assigned), or is being recorded by a concurrent request (fingerprint_event_in_progress, retryable)" }, { "header": [], "code": 422, "body": "{\"message\":\"The Fingerprint event was not collected on a registered origin for this partner.\",\"code\":\"fingerprint_event_origin_not_allowed\",\"retryable\":false}", "name": "The event or actor failed verification. Codes: actor_invalid, action_subject_mismatch, settlement_subject_not_buyer, transaction_subject_not_party, transaction_creation_evidence_too_late, fingerprint_event_not_found (retryable), fingerprint_event_invalid, fingerprint_event_expired, fingerprint_event_origin_not_allowed" }, { "header": [], "code": 503, "body": "{\"message\":\"Fingerprint verification is temporarily unavailable. Retry later.\",\"code\":\"fingerprint_service_unavailable\",\"retryable\":true}", "name": "Fingerprint could not be reached or failed to process the event" } ] } ] }, { "name": "User Management", "description": "Manage Users", "item": [ { "name": "Create a new user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"initiate_mobile_verification_flow\":\"yes\",\"address\":{\"unit_number\":\"10B\",\"street_number\":\"123\",\"street\":\"Smith St\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"postcode\":\"2000\"}}" }, "description": "Creates a new user. Email and phone must be unique. The user will be automatically associated with the authenticated partner. If the authenticated Partner has welcome emails enabled, newly created API users receive a GoEscrow Welcome By Partner email with a 24-hour, single-use password setup link." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"kyc_verified\":false,\"aml_verified\":false,\"aml_verified_at\":null,\"email_verified\":false,\"mobile_verified\":false,\"mobilekyc_verified\":false,\"bank_verified\":false,\"suspended\":false,\"address\":{\"unit_number\":\"10B\",\"street_number\":\"123\",\"street\":\"Smith St\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"postcode\":\"2000\",\"country\":\"Australia\"},\"companies\":[]}}", "name": "User created successfully" } ] }, { "name": "Update a user", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:id", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"address\":{\"unit_number\":\"10B\",\"street_number\":\"123\",\"street\":\"Smith St\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"postcode\":\"2000\"}}" }, "description": "Updates an existing user for the authenticated partner. Email and phone must remain unique." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"kyc_verified\":false,\"aml_verified\":false,\"aml_verified_at\":null,\"email_verified\":false,\"mobile_verified\":false,\"mobilekyc_verified\":false,\"bank_verified\":false,\"suspended\":false,\"address\":{\"unit_number\":\"10B\",\"street_number\":\"123\",\"street\":\"Smith St\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"postcode\":\"2000\",\"country\":\"Australia\"},\"companies\":[{\"id\":\"9d2e5c8a-8765-4321-9abc-def012345678\",\"reference\":\"XYZ789\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"53004085616\",\"kyb_verified\":true}]}}", "name": "User updated successfully" } ] }, { "name": "Lookup user or company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/lookup", "query": [ { "key": "email", "value": "john.doe@example.com", "description": "The user's email address. Supply exactly one of email, phone, or reference.", "disabled": false }, { "key": "phone", "value": "+61412345678", "description": "The user's phone number. Supply exactly one of email, phone, or reference. Accepts 0412345678, +61412345678, or 61412345678. Numbers from other countries must include the country code (e.g., +447911123456).", "disabled": false }, { "key": "reference", "value": "ABC123", "description": "A user or company GoEscrow reference. Supply exactly one of email, phone, or reference.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/users\/lookup?email=john.doe%40example.com&phone=%2B61412345678&reference=ABC123" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Look up an existing user by email, phone, or GoEscrow reference. Company reference matches return only the company name and reference. Exactly one parameter must be provided." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"kyc_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-06-25T00:00:00.000000Z\",\"email_verified\":true,\"mobile_verified\":true,\"mobilekyc_verified\":true,\"bank_verified\":true,\"suspended\":false,\"address\":{\"unit_number\":\"1\",\"street_number\":\"123\",\"street\":\"Main Street\",\"suburb\":\"Sydney\",\"state\":\"NSW\",\"postcode\":\"2000\",\"country\":\"Australia\"},\"companies\":[{\"id\":\"9d2e5c8a-8765-4321-9abc-def012345678\",\"reference\":\"XYZ789\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"53004085616\",\"kyb_verified\":true}]}}", "name": "User found" }, { "header": [], "code": 200, "body": "{\"data\":{\"name\":\"Acme Corp Pty Ltd\",\"reference\":\"XYZ789\"}}", "name": "Company found by reference; representative and contact details are never returned" }, { "header": [], "code": 404, "body": "{\"message\":\"User or company not found.\"}", "name": "No accessible reference match found" }, { "header": [], "code": 422, "body": "{\"message\":\"At least one of email or phone is required.\"}", "name": "No lookup parameter supplied (legacy user lookup contract)" }, { "header": [], "code": 422, "body": "{\"message\":\"Please provide either email or phone, not both.\"}", "name": "Both legacy user lookup parameters supplied" }, { "header": [], "code": 422, "body": "{\"message\":\"Please provide only one of email, phone, or reference.\"}", "name": "Reference combined with another lookup parameter" } ] }, { "name": "Send mobile verification code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verify-mobile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verify-mobile", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends a verification code via SMS to the user's registered phone number. The code will be valid for a limited time." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Verification code sent successfully" } ] }, { "name": "Verify mobile phone", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verify-mobile", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verify-mobile", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Verifies the mobile phone number using the code sent via SMS. Upon successful verification, the user's phone will be marked as verified." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Phone number verified successfully" } ] }, { "name": "Send email verification code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verify-email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verify-email", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends a verification code via email to the user's registered email address. The code will be valid for a limited time." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Verification code sent successfully" } ] }, { "name": "Verify email address", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verify-email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verify-email", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Verifies the email address using the code sent via email. Upon successful verification, the user's email will be marked as verified." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Email address verified successfully" } ] }, { "name": "Send the mobile ID scan", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/mobile-verification-flow", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/mobile-verification-flow", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends the user an SMS link to the mobile ID scan for an existing user. Works whether or not the user has already completed KYC or AML verification, so a partner can ask for a fresh scan at any time. The user's current verification status is kept: a scan that is declined or abandoned does not remove KYC or AML verification the user already holds. Sending again within an hour resends the same link. Limited to 5 sends per user every 10 minutes." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "The ID scan link was sent to the user by SMS" }, { "header": [], "code": 422, "body": "{\"message\":\"User not found or access denied.\"}", "name": "The user does not belong to the authenticated partner" }, { "header": [], "code": 422, "body": "{\"message\":\"The given data was invalid.\",\"errors\":{\"phone\":[\"Phone number is required for mobile identification flow.\"]}}", "name": "The user has no phone number" }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Too many sends for this user" }, { "header": [], "code": 502, "body": "{\"message\":\"Failed to initiate mobile identification flow. Please try again later.\"}", "name": "The ID scan provider could not start a session" } ] }, { "name": "Generate user bank statement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/bank-statement", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/bank-statement", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Generates and returns a PDF bank statement for the specified user. The statement includes transaction history and account details." }, "response": [ { "header": [], "code": 200, "body": "[]", "name": "PDF bank statement generated successfully" } ] }, { "name": "Upload user files", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/files", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/files", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "src": [], "type": "file" } ] }, "description": "Uploads one or more files to a user filing cabinet. The authenticated partner must own the user." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"file\":\"a1b2c3d4\\\/document.pdf\",\"filename\":\"document.pdf\",\"created_at\":\"2024-01-15T10:30:00Z\"}]}", "name": "Files uploaded" }, { "header": [], "code": 422, "body": "{\"message\":\"User not found or access denied.\"}", "name": "Not authorised" } ] }, { "name": "Generate password reset link", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/password-reset-link", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/password-reset-link", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"send_email\":true}" }, "description": "Generates a short-lived password reset link for the user." }, "response": [ { "header": [], "code": 200, "body": "{\"reset_url\":\"https:\\\/\\\/app.goescrow.com.au\\\/auth\\\/forgot-password\\\/abc123\",\"expires_in\":\"60 minutes\"}", "name": "" } ] } ] }, { "name": "Dispute Management", "description": "Create and manage transaction disputes", "item": [ { "name": "Create a dispute", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/disputes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/disputes" }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"requester_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"requester_role\":\"buyer\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"request_type\":\"pause\",\"issue_description\":\"The goods were not delivered as described.\"}" }, "description": "Creates a dispute for a transaction. This will mark the transaction as disputed and create a compliance note for the CS team to review." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"Dispute created successfully.\",\"dispute_reference\":\"DISP-2024-001234\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"disputed\"}", "name": "Dispute created" }, { "header": [], "code": 422, "body": "{\"message\":\"Transaction status does not allow disputes.\"}", "name": "Invalid transaction status" } ] } ] }, { "name": "Transaction Cancellation", "description": "Manage cancellation requests and approvals for partner transactions.\n\n### Multiple payees: standard and marketplace Anytime and Timed transactions\n\nA transaction with two or more disbursement entries uses per-party cancellation approval. The API derives the parties from the saved payer and disbursement recipients. Do not include a list of other parties or resend the disbursement array in cancellation requests. All calls below use the existing `\/api\/v1\/transactions\/{transaction_id}` endpoints.\n\n1. POST `\/cancellation-request` with `requester_id`, the requesting user or company UUID. For a company with multiple representatives, also send `representative_id`, the UUID of the linked user acting for that company. Use the same representative for code delivery and verification.\n2. If `requires_2fa` is true, codes have been sent but the request has not yet been created. POST `\/verify-cancellation` with the same actor details, `email_code` and `phone_code` to create it.\n3. Save the returned `cancellation_request_id`. Each other party POSTs `\/cancellation-accept` with its own `accepter_id`, the current `cancellation_request_id` and, where needed, `representative_id`.\n4. If acceptance returns `requires_2fa: true`, that party POSTs `\/verify-cancellation-accept` with the same actor details and request ID, plus `email_code` and `phone_code`.\n5. A party still requiring approval can instead POST `\/cancellation-deny` with `denier_id`, the current `cancellation_request_id` and, where needed, `representative_id`. Denial does not require verification codes.\n\nFor example, an individual requests cancellation without listing the other parties:\n\n```json\n{\"requester_id\": \"9d2e5c8a-1234-5678-9abc-def012345678\"}\n```\n\nAfter the request is created, another party accepts using the returned request ID:\n\n```json\n{\"accepter_id\": \"9d2e5c8a-1234-5678-9abc-def012345680\", \"cancellation_request_id\": \"2c9bb6a0-b123-4567-89ab-0123456789ab\"}\n```\n\nMarketplace cancellation includes the payer and every disbursement recipient, including fee recipients. The marketplace operator is not an additional approval party solely because it is the operator. Beneficiaries confirm receipt of goods or services; they are not cancellation parties. Cancellation can start while beneficiary confirmation is outstanding, and settlement is blocked while cancellation is pending.\n\nThe requester contributes the first approval. With one payer and two distinct payees, all three legal parties must approve; one representative acting for two companies must approve separately for each company. An HTTP 200 can mean only that one approval was recorded. The transaction remains `cancellation_requested` until all required approvals are complete. Check `status` for `canceled`; refund processing may still be pending.\n\nPending multi-payee transactions also require all parties to approve; they are not cancelled immediately. Partially or fully funded multi-payee transactions require email and phone verification for every approval, based on positive, unreversed payment receipts. If funding arrives after an unverified approval, that party must approve again with verification. Codes expire after five minutes and are bound to the transaction, legal party, representative and cancellation attempt.\n\nA missing or stale `cancellation_request_id` on acceptance, acceptance verification or denial returns HTTP 422. Refresh the transaction and use the current ID; do not replay an old approval against a new request. The response ID is null before a request is created and after cancellation or denial ends it. Older active requests without a generated ID return `legacy`; send the returned value unchanged.\n\nDenial normally restores the previous status. Marketplace denial rechecks beneficiary requirements before restoring accepted or awaiting_beneficiary_confirmation. For a multi-payee Timed transaction less than 12 hours before a future release, denial instead sets `contact_helpdesk`, suspends payee settlements and alerts customer service.\n\nSingle-payee and Super Disbursement transactions retain their existing cancellation flow. The multi-payee-only fields and approval rules below do not change that flow.", "item": [ { "name": "Request transaction cancellation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/cancellation-request", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/cancellation-request", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"requester_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"representative_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\"}" }, "description": "Initiates cancellation. For standard and marketplace multi-payee Anytime and Timed transactions, supply only the requesting party ID and, when needed, its representative ID; the API already knows the other parties. Unfunded pending, accepted or awaiting_beneficiary_confirmation transactions enter cancellation_requested with the requester approval recorded. If requires_2fa is true, call verify-cancellation to create the request. Single-payee pending transactions retain immediate cancellation; accepted transactions retain the existing counterparty flow." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Cancellation requested. 2FA verification required. Codes sent to requester's email and phone.\",\"requires_2fa\":true,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"accepted\"}", "name": "2FA required for funded accepted transaction" }, { "header": [], "code": 200, "body": "{\"message\":\"Cancellation requested. Waiting for counterparty response.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\"}", "name": "Cancellation request created" }, { "header": [], "code": 200, "body": "{\"message\":\"Transaction cancelled successfully.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"canceled\"}", "name": "Single-payee pending transaction cancelled" }, { "header": [], "code": 200, "body": "{\"message\":\"Approval recorded. Waiting for the remaining parties.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}", "name": "Multi-payee approval recorded; other parties must still approve" }, { "header": [], "code": 200, "body": "{\"message\":\"Verification codes sent. Verify them to record this party\\u2019s approval.\",\"requires_2fa\":true,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"accepted\",\"cancellation_request_id\":null}", "name": "Multi-payee verification codes sent; approval not yet recorded" } ] }, { "name": "Verify cancellation request 2FA codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/verify-cancellation", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/verify-cancellation", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"requester_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"email_code\":\"123456\",\"phone_code\":\"654321\",\"representative_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\"}" }, "description": "Verifies requester codes and creates the cancellation request. For multi-payee transactions, this records only the requester approval and returns cancellation_request_id for the remaining parties. Use the same requester_id and representative_id as the code-delivery call. No cancellation_request_id is needed to create the request." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Cancellation requested. Waiting for counterparty response.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\"}", "name": "Cancellation request created" }, { "header": [], "code": 200, "body": "{\"message\":\"Approval recorded. Waiting for the remaining parties.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}", "name": "Multi-payee approval recorded; other parties must still approve" }, { "header": [], "code": 422, "body": "{\"message\":\"Invalid or expired verification codes.\"}", "name": "Invalid codes" } ] }, { "name": "Accept transaction cancellation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/cancellation-accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/cancellation-accept", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"accepter_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"representative_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}" }, "description": "Records approval from one outstanding party. Multi-payee requests require the current cancellation_request_id. If requires_2fa is true, codes were sent but approval is not yet recorded: call verify-cancellation-accept. Otherwise HTTP 200 may still have status cancellation_requested while other approvals are outstanding. Only the final required approval completes cancellation. Single-payee requests retain the existing counterparty flow." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Cancellation acceptance requires 2FA verification. Codes sent to accepter's email and phone.\",\"requires_2fa\":true,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\"}", "name": "2FA required for funded transaction" }, { "header": [], "code": 200, "body": "{\"message\":\"Cancellation accepted. Transaction cancelled successfully.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"canceled\"}", "name": "Cancellation accepted" }, { "header": [], "code": 200, "body": "{\"message\":\"Approval recorded. Waiting for the remaining parties.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}", "name": "Multi-payee approval recorded; other parties must still approve" }, { "header": [], "code": 200, "body": "{\"message\":\"Verification codes sent. Verify them to record this party\\u2019s approval.\",\"requires_2fa\":true,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}", "name": "Multi-payee verification codes sent; approval not yet recorded" }, { "header": [], "code": 200, "body": "{\"message\":\"All parties approved. Transaction cancelled.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"canceled\",\"cancellation_request_id\":null}", "name": "Multi-payee final approval completes cancellation" }, { "header": [], "code": 422, "body": "{\"message\":\"The cancellation request has changed. Refresh the transaction and try again.\",\"errors\":{\"cancellation_request_id\":[\"The cancellation request has changed. Refresh the transaction and try again.\"]}}", "name": "Multi-payee cancellation request ID missing or stale" } ] }, { "name": "Verify cancellation acceptance 2FA codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/verify-cancellation-accept", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/verify-cancellation-accept", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"accepter_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"email_code\":\"123456\",\"phone_code\":\"654321\",\"representative_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}" }, "description": "Verifies one party approval using email_code and phone_code. For multi-payee transactions, include the current cancellation_request_id and use the same accepter_id and representative_id as the code-delivery call. Cancellation remains pending until the payer and every payee have approved with any required verification." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Cancellation accepted. Transaction cancelled successfully.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"canceled\"}", "name": "Cancellation accepted" }, { "header": [], "code": 200, "body": "{\"message\":\"Approval recorded. Waiting for the remaining parties.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"cancellation_requested\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}", "name": "Multi-payee approval recorded; other parties must still approve" }, { "header": [], "code": 200, "body": "{\"message\":\"All parties approved. Transaction cancelled.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"canceled\",\"cancellation_request_id\":null}", "name": "Multi-payee final approval completes cancellation" }, { "header": [], "code": 422, "body": "{\"message\":\"Invalid or expired verification codes.\"}", "name": "Invalid codes" }, { "header": [], "code": 422, "body": "{\"message\":\"The cancellation request has changed. Refresh the transaction and try again.\",\"errors\":{\"cancellation_request_id\":[\"The cancellation request has changed. Refresh the transaction and try again.\"]}}", "name": "Multi-payee cancellation request ID missing or stale" } ] }, { "name": "Deny transaction cancellation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/cancellation-deny", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/cancellation-deny", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"denier_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"representative_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"cancellation_request_id\":\"2c9bb6a0-b123-4567-89ab-0123456789ab\"}" }, "description": "Denies an active cancellation request without verification codes. For multi-payee transactions, only a party still requiring approval may deny; supply the current cancellation_request_id. Normally restores the previous status. Within 12 hours before a future Timed release, multi-payee denial instead sets contact_helpdesk, suspends payee settlements and alerts customer service. Single-payee requests retain their existing denial flow." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Cancellation denied. Transaction reverted to active status.\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"accepted\"}", "name": "Cancellation denied" }, { "header": [], "code": 200, "body": "{\"message\":\"Cancellation denied. Transaction is active again.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"accepted\",\"cancellation_request_id\":null}", "name": "Multi-payee cancellation denied; previous status restored" }, { "header": [], "code": 200, "body": "{\"message\":\"Transaction under review. CS Team has been notified.\",\"requires_2fa\":false,\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"contact_helpdesk\",\"cancellation_request_id\":null}", "name": "Multi-payee Timed cancellation denial requires safety review" }, { "header": [], "code": 422, "body": "{\"message\":\"The cancellation request has changed. Refresh the transaction and try again.\",\"errors\":{\"cancellation_request_id\":[\"The cancellation request has changed. Refresh the transaction and try again.\"]}}", "name": "Multi-payee cancellation request ID missing or stale" } ] } ] }, { "name": "Transaction Management", "description": "Manage Transactions", "item": [ { "name": "Create transaction", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions" }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"buy\",\"type\":\"anytime_escrow\",\"amount_type\":\"escrow\",\"other_user\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"other_company_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"sub_type\":\"marketplace\",\"user_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"company_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"marketplace_operator_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"release_at\":\"2024-12-31T23:59:59Z\",\"details\":\"Dental Surgery\",\"amount\":15000050,\"disbursements\":[\"eius\"],\"beneficiaries\":[{\"first_name\":\"Greg\",\"last_name\":\"Recipient\",\"mobile\":\"+61400000001\",\"required\":true}]}" }, "description": "Creates a new escrow transaction with disbursements. Partner API transactions are auto-accepted (skip pending status)." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"TXN-2024-001234\",\"type\":\"anytime_escrow\",\"sub_type\":\"marketplace\",\"status\":\"accepted\",\"funding_status\":\"pending\",\"amount\":150000.5,\"details\":\"Property settlement for 123 Main St\",\"created_at\":\"2024-01-15T10:30:00Z\",\"beneficiaries\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"first_name\":\"G**g\",\"last_name\":\"R*******t\",\"mobile\":\"+61******001\",\"required\":true,\"status\":\"pending\"}]}}", "name": "Transaction created successfully" }, { "header": [], "code": 422, "body": "{\"message\":\"This company is not currently eligible to transact.\",\"errors\":{\"company_id\":[\"This company is not currently eligible to transact.\"]}}", "name": "A company is inaccessible or ineligible, the parties are self-dealing, or a disbursement does not identify exactly one recipient" } ] }, { "name": "Get transaction status by identifier", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/status", "query": [ { "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier). Required when reference_id is not provided. Must not be provided with reference_id.", "disabled": false }, { "key": "reference_id", "value": "TXN-2024-001234", "description": "The transaction reference number. Required when transaction_id is not provided. Must not be provided with transaction_id.", "disabled": false }, { "key": "party_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The ID of the buyer, seller, or disbursement recipient to verify access", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/transactions\/status?transaction_id=9d2e5c8a-1234-5678-9abc-def012345678&reference_id=TXN-2024-001234&party_id=9d2e5c8a-1234-5678-9abc-def012345678" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"transaction_id\":\"0d90054a-9c5c-3ce4-8db8-625eeab6204c\",\"reference_id\":\"aut\",\"party_id\":\"f57b254a-e049-3363-a0c1-b4be4a679eac\"}" }, "description": "Returns full transaction details including funding information. Provide exactly one of transaction_id or reference_id. Requires party_id to verify access." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"TXN-2024-001234\",\"type\":\"anytime_escrow\",\"sub_type\":\"marketplace\",\"status\":\"accepted\",\"funding_status\":\"pending\",\"amount\":150000.5,\"fee\":1500,\"amount_with_fee\":151500.5,\"details\":\"Property settlement\",\"release_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"buyer_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"buyer_reference\":\"ABC123\",\"seller_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"seller_reference\":\"XYZ789\",\"other_party_hint\":\"J*** D***\",\"funding_details\":{\"bsb\":\"123456\",\"account_number\":\"12345678\",\"account_name\":\"GoEscrow Trust\",\"pay_id\":\"pay@goescrow.com.au\",\"reference\":\"TXN-2024-001234\",\"rail\":\"poprail\",\"account_scope\":\"transaction\",\"payment_reference\":\"TXN-2024-001234\",\"reference_required\":false,\"provisioning_status\":\"ready\",\"amount_received\":\"0.00\",\"amount_outstanding\":\"151500.50\"},\"beneficiaries\":[{\"id\":\"5c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f\",\"first_name\":\"J**n\",\"last_name\":\"S***h\",\"mobile\":\"+61******678\",\"required\":true,\"status\":\"pending\"}],\"settled_amount\":50000.25,\"remaining_escrow_balance\":100000.25,\"payees\":[{\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"allocation\":150000.5,\"settled_amount\":50000.25,\"remaining_amount\":100000.25}]}}", "name": "Transaction details" } ] }, { "name": "Get transaction status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:id", "query": [ { "key": "party_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The ID of the buyer or seller to verify access", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:id?party_id=9d2e5c8a-1234-5678-9abc-def012345678", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns full transaction details including funding information. Requires party_id to verify access." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"TXN-2024-001234\",\"type\":\"anytime_escrow\",\"sub_type\":\"marketplace\",\"status\":\"accepted\",\"funding_status\":\"pending\",\"amount\":150000.5,\"fee\":1500,\"amount_with_fee\":151500.5,\"details\":\"Property settlement\",\"release_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"buyer_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"buyer_reference\":\"ABC123\",\"seller_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"seller_reference\":\"XYZ789\",\"other_party_hint\":\"J*** D***\",\"funding_details\":{\"bsb\":\"123456\",\"account_number\":\"12345678\",\"account_name\":\"GoEscrow Trust\",\"pay_id\":\"pay@goescrow.com.au\",\"reference\":\"TXN-2024-001234\",\"rail\":\"poprail\",\"account_scope\":\"transaction\",\"payment_reference\":\"TXN-2024-001234\",\"reference_required\":false,\"provisioning_status\":\"ready\",\"amount_received\":\"0.00\",\"amount_outstanding\":\"151500.50\"},\"beneficiaries\":[{\"id\":\"5c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f\",\"first_name\":\"J**n\",\"last_name\":\"S***h\",\"mobile\":\"+61******678\",\"required\":true,\"status\":\"pending\"}],\"settled_amount\":50000.25,\"remaining_escrow_balance\":100000.25,\"payees\":[{\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"allocation\":150000.5,\"settled_amount\":50000.25,\"remaining_amount\":100000.25}]}}", "name": "Transaction details" } ] }, { "name": "Request beneficiary confirmation", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/beneficiaries\/:beneficiary_id\/confirmation-request", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/beneficiaries\/:beneficiary_id\/confirmation-request", "variable": [ { "id": "transaction", "key": "transaction", "value": "voluptate", "description": "The transaction UUID" }, { "id": "beneficiary", "key": "beneficiary", "value": "nemo", "description": "The beneficiary UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"heading\":\"Confirm your session\"}" }, "description": "Creates or rotates a single-use beneficiary confirmation link and sends it by SMS to the beneficiary. The token and confirmation URL are not returned to the partner." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"message\":\"Confirmation link sent\",\"beneficiary_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"sent_to\":\"+614****5678\",\"expires_at\":\"2026-08-16T12:00:00+00:00\",\"heading\":\"Confirm receipt\"}}", "name": "Confirmation link sent by SMS" } ] }, { "name": "Get transaction quote", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/quote", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/quote" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"action\":\"buy\",\"type\":\"anytime_escrow\",\"amount_type\":\"escrow\",\"other_user\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"other_company_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"sub_type\":\"super_disbursement\",\"user_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"company_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"release_at\":\"2024-12-31T23:59:59Z\",\"details\":\"Dental Surgery\",\"amount\":15000050,\"disbursements\":[\"adipisci\"]}" }, "description": "Calculates fees and provides a quote for a transaction without creating it. Uses the same request structure as transaction creation. This allows partners to show pricing to their customers before committing to a transaction." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"sub_type\":\"super_disbursement\",\"amount\":150000.5,\"partner_fee\":299.4,\"partner_fee_percentage\":0.2,\"goescrow_fee\":0,\"goescrow_fee_percentage\":0,\"total_fees\":299.4,\"net_amount\":149701.1,\"disbursements_count\":2,\"disbursements\":[{\"user_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"amount\":74850.55},{\"company_id\":\"9d2e5c8a-1234-5678-9abc-def012345680\",\"amount\":74850.55}]}}", "name": "Transaction quote calculated successfully" } ] }, { "name": "Upload transaction files", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/files", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/files", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "src": [], "type": "file" } ] }, "description": "Uploads one or more files to a transaction filing cabinet. The authenticated partner must own the transaction or be its marketplace operator." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"file\":\"a1b2c3d4\\\/document.pdf\",\"filename\":\"document.pdf\",\"created_at\":\"2024-01-15T10:30:00Z\"}]}", "name": "Files uploaded" }, { "header": [], "code": 422, "body": "{\"message\":\"Transaction not found or access denied.\"}", "name": "Not authorised" } ] }, { "name": "Send settlement codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/settle\/codes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/settle\/codes", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Sends the buyer of an Anytime or Timed escrow transaction one verification code by email and one by SMS. The buyer gives both codes to you, and you send them when you trigger settlement. Only the partner that created the transaction can call it, and API settlement must be enabled for your account. The buyer needs a verified email address and a verified mobile number. For a company buyer, the codes go to the representative on the transaction. Codes expire after 10 minutes and are thrown away after 5 incorrect attempts. Sending again replaces the previous codes. Marketplace settlement does not use codes." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Settlement codes sent to the buyer.\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"expires_at\":\"2026-10-15T10:40:00+10:00\"}", "name": "Codes sent" }, { "header": [], "code": 403, "body": "{\"message\":\"API settlement is not enabled for this partner. Contact GoEscrow to turn it on.\"}", "name": "API settlement not enabled, or not the partner that created the transaction" }, { "header": [], "code": 409, "body": "{\"message\":\"Settlement has already started for this transaction.\"}", "name": "Settlement has already started, or another request for these codes is in progress (retry shortly)" }, { "header": [], "code": 422, "body": "{\"message\":\"Marketplace settlement does not use settlement codes.\"}", "name": "Not an Anytime or Timed escrow, not ready for settlement, or the buyer has no verified email address or mobile number" }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "Codes were sent for this transaction 5 times in the last 10 minutes" } ] }, { "name": "Trigger settlement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/settle", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/settle", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"buyer_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"seller_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"settlement_amount\":150000.5,\"email_code\":\"482913\",\"sms_code\":\"105577\"}" }, "description": "Settles a funded marketplace, Anytime or Timed escrow transaction in full. API settlement must be enabled for your account. For a marketplace transaction, only the marketplace operator can trigger settlement. For an Anytime or Timed escrow, only the partner that created it can, and the buyer must approve: call Send settlement codes, then send both codes the buyer received. A Timed escrow can be settled before its release date. Before calling it, record a settlement Fingerprint event for the buyer (see Record a Fingerprint event); without one, GoEscrow holds the settlement for compliance review. A successful response means settlement has started; the transaction.status_changed webhook reports when it completes." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Settlement initiated successfully.\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"status\":\"settlement_in_progress\"}", "name": "Settlement initiated" }, { "header": [], "code": 403, "body": "{\"message\":\"Only the marketplace operator can trigger settlement.\"}", "name": "API settlement not enabled for this partner, or not the marketplace operator (marketplace) or the partner that created the transaction (Anytime and Timed escrow)" }, { "header": [], "code": 409, "body": "{\"message\":\"Settlement has already started for this transaction.\"}", "name": "Settlement has already started, another settlement is in progress, or another request for these codes is in progress (retry shortly). Send an Idempotency-Key to get the original response on a retry." }, { "header": [], "code": 422, "body": "{\"message\":\"The settlement codes are incorrect.\"}", "name": "Codes incorrect, missing or expired; transaction type not settleable via API; or buyer, seller or amount does not match" } ] }, { "name": "Create partial settlement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/partial-settlements", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/partial-settlements", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID" } ] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"amount\":5000,\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"partner_reference\":\"PC-104\\\/step-3\"}" }, "description": "Pays part of a funded marketplace transaction to one payee while the rest stays in escrow. Only the marketplace operator can call it, and API settlement must be enabled for your account. One settlement runs at a time; the transaction returns to accepted once its payout is submitted, and completes when the balance reaches zero and every payout is paid. Follow progress with the settlement.submitted, settlement.paid and settlement.failed webhooks. Only a payout the provider refused before sending is marked failed, and its amount returns to the balance. Before calling it, record a settlement Fingerprint event for the buyer (see Record a Fingerprint event); without one, GoEscrow holds the settlement for compliance review." }, "response": [ { "header": [], "code": 202, "body": "{\"data\":{\"settlement_id\":\"4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"transaction_reference\":\"12345678\",\"status\":\"processing\",\"amount\":5000,\"payee\":{\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"allocation\":20000,\"settled_amount\":5000,\"remaining_amount\":15000},\"remaining_escrow_balance\":15000,\"transaction_status\":\"settlement_in_progress\",\"partner_reference\":\"PC-104\\\/step-3\",\"created_at\":\"2026-09-26T10:30:00+10:00\",\"submitted_at\":null,\"paid_at\":null,\"failed_at\":null}}", "name": "Partial settlement started" }, { "header": [], "code": 400, "body": "{\"message\":\"An Idempotency-Key header is required for this request.\"}", "name": "Missing Idempotency-Key" }, { "header": [], "code": 403, "body": "{\"message\":\"Only the marketplace operator can settle this transaction.\"}", "name": "Not the marketplace operator, or API settlement is not enabled for this partner" }, { "header": [], "code": 409, "body": "{\"message\":\"A settlement is already in progress for this transaction.\"}", "name": "Another settlement is in progress" }, { "header": [], "code": 422, "body": "{\"message\":\"The settlement amount is more than the remaining escrow balance.\"}", "name": "Amount, payee or transaction state not valid" } ] }, { "name": "List partial settlements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/partial-settlements", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/partial-settlements", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists every partial settlement of a transaction, newest first. Only the marketplace operator can call it." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"settlement_id\":\"4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"transaction_reference\":\"12345678\",\"status\":\"processing\",\"amount\":5000,\"payee\":{\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"allocation\":20000,\"settled_amount\":5000,\"remaining_amount\":15000},\"remaining_escrow_balance\":15000,\"transaction_status\":\"settlement_in_progress\",\"partner_reference\":\"PC-104\\\/step-3\",\"created_at\":\"2026-09-26T10:30:00+10:00\",\"submitted_at\":null,\"paid_at\":null,\"failed_at\":null}]}", "name": "Partial settlements" }, { "header": [], "code": 403, "body": "{\"message\":\"Only the marketplace operator can settle this transaction.\"}", "name": "Not the marketplace operator" } ] }, { "name": "Get partial settlement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/partial-settlements\/:settlement_id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/partial-settlements\/:settlement_id", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID" }, { "id": "settlement_id", "key": "settlement_id", "value": "4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f", "description": "The settlement ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns one partial settlement of a transaction. Only the marketplace operator can call it." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"settlement_id\":\"4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\",\"transaction_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"transaction_reference\":\"12345678\",\"status\":\"processing\",\"amount\":5000,\"payee\":{\"payee_id\":\"9d2e5c8a-1234-5678-9abc-def012345679\",\"allocation\":20000,\"settled_amount\":5000,\"remaining_amount\":15000},\"remaining_escrow_balance\":15000,\"transaction_status\":\"settlement_in_progress\",\"partner_reference\":\"PC-104\\\/step-3\",\"created_at\":\"2026-09-26T10:30:00+10:00\",\"submitted_at\":null,\"paid_at\":null,\"failed_at\":null}}", "name": "Partial settlement" }, { "header": [], "code": 403, "body": "{\"message\":\"Only the marketplace operator can settle this transaction.\"}", "name": "Not the marketplace operator" }, { "header": [], "code": 404, "body": "{\"message\":\"No query results for model [App\\\\Models\\\\TransactionSettlement] 4b1f6c2e-8d3a-4e5b-9c7d-1a2b3c4d5e6f\"}", "name": "The settlement does not belong to this transaction" } ] } ] }, { "name": "Transaction PayTo Payment", "description": "Initiate PayTo Payments for Transactions", "item": [ { "name": "Initiate PayTo payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/payto-payment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/payto-payment", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "6f3a8e1c-9b2d-4f5a-8c1e-2a7b9d0e1f23" }, { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"9d2e5c8a-1234-5678-9abc-def012345678\"}" }, "description": "Initiates a PayTo debit payment from the specified user's bank account to fund the transaction. The user must have an active PayTo agreement. This endpoint dispatches an async job and returns immediately with a tracking ID." }, "response": [ { "header": [], "code": 202, "body": "{\"code\":\"accepted\",\"message\":\"Payment initiation queued. Use the tracking_id to poll for status.\",\"tracking_id\":\"payto_9d2e5c8a\"}", "name": "Payment initiation queued for processing" }, { "header": [], "code": 400, "body": "{\"code\":\"transaction_already_funded\",\"message\":\"This transaction is already funded.\"}", "name": "Transaction already funded" }, { "header": [], "code": 400, "body": "{\"code\":\"no_payment_agreement\",\"message\":\"User does not have a PayTo agreement set up.\"}", "name": "PayTo not configured" } ] }, { "name": "Check PayTo payment status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/:transaction_id\/payto-payment\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/:transaction_id\/payto-payment\/:id", "variable": [ { "id": "transaction_id", "key": "transaction_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The transaction UUID (36-character internal identifier)" }, { "id": "id", "key": "id", "value": "payto_abc123", "description": "Either a tracking_id (e.g., payto_abc123) or a payment_initiation_id (e.g., PI-123456789)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Checks the status of a PayTo payment using either a tracking_id (from async initiation) or a payment_initiation_id." }, "response": [ { "header": [], "code": 200, "body": "{\"code\":\"settled\",\"message\":\"Payment settled successfully. Transaction is now funded.\",\"status\":\"settled\"}", "name": "Payment settled" }, { "header": [], "code": 200, "body": "{\"code\":\"pending\",\"message\":\"Payment is still processing.\",\"status\":\"pending\"}", "name": "Payment pending" }, { "header": [], "code": 200, "body": "{\"code\":\"failed\",\"status\":\"failed\",\"tracking_id\":\"payto_9b2f1c4e\",\"message\":\"Cannot initiate payment. Transaction status: canceled\",\"error_code\":\"transaction_not_payable\"}", "name": "Payment failed" }, { "header": [], "code": 200, "body": "{\"code\":\"queued\",\"message\":\"Payment initiation is queued for processing.\",\"status\":\"queued\"}", "name": "Job queued" } ] } ] }, { "name": "User Bank Account Management", "description": "Manage User Bank Accounts", "item": [ { "name": "Update user bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/bank-account", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bsb_number\":\"123456\",\"account_number\":\"12345678\",\"account_name\":\"John Doe\"}" }, "description": "Updates the bank account details for a user. This will automatically trigger a verification payout of $0.01 to the new account with a 6-digit verification code in the transaction description." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Bank account updated. Verification code sent via $0.01 payout.\",\"is_verified\":false}", "name": "Bank account updated successfully" } ] }, { "name": "Verify user bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/bank-account\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/bank-account\/verify", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"123456\"}" }, "description": "Verifies the bank account using the 6-digit code received in the $0.01 verification payout." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Bank account verified successfully.\",\"is_verified\":true}", "name": "Bank account verified successfully" }, { "header": [], "code": 422, "body": "{\"message\":\"The verification code is incorrect.\"}", "name": "Invalid verification code" } ] } ] }, { "name": "User Identification Management", "description": "Manage User Identification Documents", "item": [ { "name": "Create or update user passport", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/passport", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/passport", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"document_number\":\"N1234567\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"issuing_country\":\"United Kingdom\",\"nationality\":\"British\",\"date_of_birth\":\"1990-01-15\",\"date_of_issue\":\"2020-01-15\",\"date_of_expiration\":\"2030-01-15\",\"place_of_birth\":\"Sydney, Australia\",\"gender\":\"M\"}" }, "description": "Creates a new passport record for the user or updates an existing one. Only one passport per user is allowed." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"document_number\":\"N1234567\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"nationality\":\"United Kingdom\",\"issuing_country\":\"United Kingdom\",\"date_of_birth\":\"1990-01-15\",\"date_of_issue\":\"2020-01-15\",\"date_of_expiration\":\"2030-01-15\",\"place_of_birth\":\"Sydney, Australia\",\"gender\":\"M\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Passport created\/updated successfully" } ] }, { "name": "Get user passport", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/passport", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/passport", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the passport information for the specified user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"document_number\":\"N1234567\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"nationality\":\"United Kingdom\",\"issuing_country\":\"United Kingdom\",\"date_of_birth\":\"1990-01-15\",\"date_of_issue\":\"2020-01-15\",\"date_of_expiration\":\"2030-01-15\",\"place_of_birth\":\"Sydney, Australia\",\"gender\":\"M\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Passport retrieved successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Passport not found for this user.\"}", "name": "Passport not found" } ] }, { "name": "Delete user passport", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/passport", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/passport", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the passport record for the specified user." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Passport deleted successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Passport not found for this user.\"}", "name": "Passport not found" } ] }, { "name": "Create or update user Medicare card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/medicare", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/medicare", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"document_number\":\"1234567890\",\"name_on_card\":\"John Michael Doe\",\"card_color\":\"green\",\"individual_reference_number\":\"1\",\"expiration_date\":\"2025-12\"}" }, "description": "Creates a new Medicare card record for the user or updates an existing one. Only one Medicare card per user is allowed." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"document_number\":\"1234567890\",\"name_on_card\":\"John Michael Doe\",\"card_color\":\"green\",\"individual_reference_number\":\"1\",\"expiration_date\":\"2025-12\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Medicare card created\/updated successfully" } ] }, { "name": "Get user Medicare card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/medicare", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/medicare", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the Medicare card information for the specified user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"document_number\":\"1234567890\",\"name_on_card\":\"John Michael Doe\",\"card_color\":\"green\",\"individual_reference_number\":\"1\",\"expiration_date\":\"2025-12\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Medicare card retrieved successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Medicare card not found for this user.\"}", "name": "Medicare card not found" } ] }, { "name": "Delete user Medicare card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/medicare", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/medicare", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the Medicare card record for the specified user." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Medicare card deleted successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Medicare card not found for this user.\"}", "name": "Medicare card not found" } ] }, { "name": "Create or update user driver license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/driver-license", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/driver-license", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"state_issued\":\"NSW\",\"license_number\":\"12345678\",\"card_number\":\"1234567890\",\"expiration_date\":\"2030-01-15\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"date_of_birth\":\"1990-01-15\"}" }, "description": "Creates a new driver license record for the user or updates an existing one. Only one driver license per user is allowed." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"state_issued\":\"NSW\",\"license_number\":\"12345678\",\"card_number\":\"1234567890\",\"expiration_date\":\"2030-01-15\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"date_of_birth\":\"1990-01-15\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Driver license created\/updated successfully" } ] }, { "name": "Get user driver license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/driver-license", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/driver-license", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the driver license information for the specified user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"state_issued\":\"NSW\",\"license_number\":\"12345678\",\"card_number\":\"1234567890\",\"expiration_date\":\"2030-01-15\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"middle_name\":\"Michael\",\"date_of_birth\":\"1990-01-15\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Driver license retrieved successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Driver license not found for this user.\"}", "name": "Driver license not found" } ] }, { "name": "Delete user driver license", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/driver-license", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/driver-license", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the driver license record for the specified user." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Driver license deleted successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Driver license not found for this user.\"}", "name": "Driver license not found" } ] }, { "name": "Create or update user immigration card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/immigration-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/immigration-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"given_name\":\"John\",\"family_name\":\"Doe\",\"card_number\":\"IMM123456\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"ams\",\"vevo_check_given_name\":\"John\",\"vevo_check_family_name\":\"Doe\",\"vevo_check_passport_number\":\"N1234567\",\"vevo_check_country_of_issue\":\"Australia\"}" }, "description": "Creates a new immigration card record for the user or updates an existing one. Only one immigration card per user is allowed." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"given_name\":\"John\",\"family_name\":\"Doe\",\"card_number\":\"IMM123456\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"ams\",\"vevo_check_given_name\":\"John\",\"vevo_check_family_name\":\"Doe\",\"vevo_check_passport_number\":\"N1234567\",\"vevo_check_country_of_issue\":\"Australia\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Immigration card created\/updated successfully" } ] }, { "name": "Get user immigration card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/immigration-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/immigration-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the immigration card information for the specified user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"given_name\":\"John\",\"family_name\":\"Doe\",\"card_number\":\"IMM123456\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"ams\",\"vevo_check_given_name\":\"John\",\"vevo_check_family_name\":\"Doe\",\"vevo_check_passport_number\":\"N1234567\",\"vevo_check_country_of_issue\":\"Australia\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Immigration card retrieved successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Immigration card not found for this user.\"}", "name": "Immigration card not found" } ] }, { "name": "Delete user immigration card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/immigration-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/immigration-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the immigration card record for the specified user." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Immigration card deleted successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Immigration card not found for this user.\"}", "name": "Immigration card not found" } ] }, { "name": "Create or update user Centrelink card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/centrelink-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/centrelink-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"crn\":\"123456789A\",\"name_on_card\":\"John Doe\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"hcc\"}" }, "description": "Creates a new Centrelink card record for the user or updates an existing one. Only one Centrelink card per user is allowed." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"crn\":\"123456789A\",\"name_on_card\":\"John Doe\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"hcc\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Centrelink card created\/updated successfully" } ] }, { "name": "Get user Centrelink card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/centrelink-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/centrelink-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Retrieves the Centrelink card information for the specified user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"crn\":\"123456789A\",\"name_on_card\":\"John Doe\",\"expiration_date\":\"2030-01-15\",\"card_type\":\"hcc\",\"rapidid_verification_requested_at\":null,\"rapidid_verified_at\":null,\"rapidid_failed_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"updated_at\":\"2024-01-15T10:30:00Z\"}}", "name": "Centrelink card retrieved successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Centrelink card not found for this user.\"}", "name": "Centrelink card not found" } ] }, { "name": "Delete user Centrelink card", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/centrelink-card", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/centrelink-card", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the Centrelink card record for the specified user." }, "response": [ { "header": [], "code": 204, "body": "[]", "name": "Centrelink card deleted successfully" }, { "header": [], "code": 404, "body": "{\"error\":\"Centrelink card not found for this user.\"}", "name": "Centrelink card not found" } ] } ] }, { "name": "User PayTo Agreement Management", "description": "Manage User PayTo Agreements", "item": [ { "name": "Get PayTo agreement status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/payto-agreement", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/payto-agreement", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the current PayTo agreement status and details for a user." }, "response": [ { "header": [], "code": 200, "body": "{\"has_agreement\":true,\"agreement_id\":\"PA-123456\",\"maximum_amount\":10000,\"status\":\"ACTIVE\"}", "name": "PayTo agreement found" }, { "header": [], "code": 200, "body": "{\"has_agreement\":false,\"agreement_id\":null,\"maximum_amount\":null,\"status\":null}", "name": "No PayTo agreement" } ] }, { "name": "Create PayTo agreement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/payto-agreement", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/payto-agreement", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"maximum_amount\":5000,\"pay_id\":\"john@example.com\",\"pay_id_type\":\"EMAIL\",\"account_name\":\"John Doe\",\"account_number\":\"12345678\",\"bsb\":\"123456\"}" }, "description": "Creates a new PayTo agreement for the user. The user must authorize the agreement in their banking app." }, "response": [ { "header": [], "code": 201, "body": "{\"agreement_id\":\"PA-123456\",\"status\":\"CREATED\",\"message\":\"PayTo agreement created. User must authorize in their banking app.\"}", "name": "PayTo agreement created" } ] } ] }, { "name": "Webhook Management", "description": "Manage webhook subscriptions for transaction events", "item": [ { "name": "List webhooks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns all registered webhooks for the authenticated partner." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"url\":\"https:\\\/\\\/partner.com\\\/webhooks\\\/goescrow\",\"events\":[\"transaction.created\",\"transaction.clearance_pending\",\"transaction.funded\",\"transaction.status_changed\",\"transaction.funding_status_changed\"],\"is_active\":true,\"last_triggered_at\":\"2024-01-15T10:30:00Z\",\"failure_count\":0,\"created_at\":\"2024-01-01T00:00:00Z\"}]}", "name": "List of webhooks" } ] }, { "name": "Register webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/partner.com\\\/webhooks\\\/goescrow\",\"events\":[\"transaction.created\",\"beneficiary.confirmation_requested\",\"beneficiary.confirmed\",\"beneficiary.declined\"]}" }, "description": "Registers a new webhook URL to receive transaction event notifications. Available events: transaction.created (when a transaction is created), transaction.clearance_pending (when inbound funding is held for clearance), transaction.funded (when a transaction is funded), transaction.status_changed (when transaction status changes), transaction.funding_status_changed (when transaction funding status changes), transaction.completed (when a transaction is completed\/settled), beneficiary.confirmation_requested (when beneficiary confirmation is requested), beneficiary.confirmed (when a beneficiary confirms receipt), beneficiary.declined (when a beneficiary reports non-receipt), settlement.submitted (when a partial settlement payout is accepted by the provider), settlement.paid (when a partial settlement payout is confirmed paid), settlement.failed (when a partial settlement payout was refused before it left, and its amount returns to the balance)." }, "response": [ { "header": [], "code": 201, "body": "{\"message\":\"Webhook registered successfully.\",\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"url\":\"https:\\\/\\\/partner.com\\\/webhooks\\\/goescrow\",\"secret\":\"whsec_abc123xyz789...\",\"events\":[\"transaction.created\",\"transaction.clearance_pending\"]}", "name": "Webhook registered" } ] }, { "name": "Delete webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id", "variable": [ { "id": "webhook", "key": "webhook", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The webhook ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Unregisters a webhook." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Webhook deleted successfully.\"}", "name": "Webhook deleted" }, { "header": [], "code": 404, "body": "{\"message\":\"Webhook not found.\"}", "name": "Webhook not found" } ] }, { "name": "List webhook deliveries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook_id\/deliveries", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook_id\/deliveries", "variable": [ { "id": "webhook", "key": "webhook", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The webhook ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the delivery history for a webhook (most recent first), so missed events can be inspected and replayed after an outage. Each delivery records the event, the exact payload that was (or will be) sent, the number of attempts, and the last response status." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"9f1b2c3d-4567-89ab-cdef-0123456789ab\",\"event\":\"transaction.funded\",\"status\":\"failed\",\"attempts\":3,\"response_status\":500,\"last_attempted_at\":\"2024-01-15T10:32:00Z\",\"delivered_at\":null,\"created_at\":\"2024-01-15T10:30:00Z\",\"payload\":{\"transaction_id\":\"...\",\"status\":\"pending\"}}],\"meta\":{\"current_page\":1,\"last_page\":1,\"per_page\":50,\"total\":1}}", "name": "List of deliveries" } ] }, { "name": "Redeliver a webhook event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:webhook_id\/deliveries\/:delivery_id\/redeliver", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:webhook_id\/deliveries\/:delivery_id\/redeliver", "variable": [ { "id": "webhook", "key": "webhook", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The webhook ID" }, { "id": "delivery", "key": "delivery", "value": "9f1b2c3d-4567-89ab-cdef-0123456789ab", "description": "The delivery ID to redeliver" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Queues a fresh delivery attempt for a past event, using the original payload. Use this to backfill events your endpoint missed during an outage. A new delivery record is created (with a new id) so the original attempt history is preserved." }, "response": [ { "header": [], "code": 202, "body": "{\"message\":\"Webhook delivery has been queued for redelivery.\",\"id\":\"a1b2c3d4-5678-90ab-cdef-1234567890ab\",\"event\":\"transaction.funded\",\"status\":\"pending\"}", "name": "Redelivery queued" }, { "header": [], "code": 404, "body": "{\"message\":\"Delivery not found.\"}", "name": "Delivery not found" }, { "header": [], "code": 409, "body": "{\"message\":\"This delivery is still in progress; wait for it to finish before redelivering.\"}", "name": "Webhook inactive, or delivery still in progress" } ] } ] }, { "name": "Company Bank Account Management", "description": "Manage company bank accounts using Confirmation of Payee", "item": [ { "name": "Update company bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/bank-account", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/bank-account", "variable": [ { "id": "company_id", "key": "company_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The company UUID (36-character internal identifier)" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"bsb_number\":\"123456\",\"account_number\":\"12345678\",\"account_name\":\"Acme Corp Pty Ltd\"}" }, "description": "Updates company bank details and runs Confirmation of Payee checks against the company's active known names." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Company bank account updated successfully.\",\"is_verified\":true}", "name": "Company bank account updated" } ] }, { "name": "Re-check company bank account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:company_id\/bank-account\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/companies\/:company_id\/bank-account\/verify", "variable": [ { "id": "company_id", "key": "company_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The company UUID (36-character internal identifier)" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Re-runs Confirmation of Payee against the company's existing bank details. This is not payout-code verification." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Company bank account check completed.\",\"is_verified\":true}", "name": "Confirmation of Payee re-check completed" } ] } ] }, { "name": "Hosted Login", "description": "Create an identity-only hosted login session, send the user to the returned GoEscrow URL, receive a one-time code at the registered redirect URL, then verify the code server-to-server. The redirect URL is configured by GoEscrow and snapshotted when the session is created.", "item": [ { "name": "Create a hosted login session", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/login-sessions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/login-sessions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"jane@example.com\",\"reference\":\"order-8812\"}" }, "description": "Creates a short-lived hosted login session. Open the returned `url` in the user's browser. After the user signs in and confirms, GoEscrow redirects to the partner's registered URL with `session_id`, `code`, and the optional `reference` query parameters.\n\n```bash\ncurl -X POST 'https:\/\/partner-api.goescrow.com.au\/api\/v1\/login-sessions' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application\/json' \\\n -d '{\"email\":\"jane@example.com\",\"reference\":\"order-8812\"}'\n```" }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"url\":\"https:\\\/\\\/app.goescrow.com.au\\\/partner-login\\\/plaintext-session-token\",\"expires_at\":\"2026-08-31T04:15:00.000000Z\",\"reference\":\"order-8812\"}}", "name": "Hosted login session created" }, { "header": [], "code": 422, "body": "{\"message\":\"Hosted login is not configured for this partner. Contact GoEscrow to register a redirect URL.\"}", "name": "No redirect URL is registered" } ] }, { "name": "Verify a hosted login code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/login-sessions\/:loginSession\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/login-sessions\/:loginSession\/verify", "variable": [ { "id": "loginSession", "key": "loginSession", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The hosted login session UUID returned during creation." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"code\":\"CODE_FROM_REDIRECT\"}" }, "description": "Redeems the one-time code delivered to the registered redirect URL. Verification must use the same partner API key that created the session and must occur before the code expires.\n\n```bash\ncurl -X POST 'https:\/\/partner-api.goescrow.com.au\/api\/v1\/login-sessions\/9d2e5c8a-1234-5678-9abc-def012345678\/verify' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application\/json' \\\n -d '{\"code\":\"CODE_FROM_REDIRECT\"}'\n```" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"user\":{\"id\":\"9d2e5c8a-1234-5678-9abc-def012345678\",\"reference\":\"ABC123\",\"first_name\":\"Jane\",\"last_name\":\"Doe\",\"email\":\"jane@example.com\",\"phone\":\"+61412345678\",\"birth_date\":\"1990-01-15\",\"kyc_verified\":true,\"aml_verified\":true,\"aml_verified_at\":\"2026-08-20T00:00:00.000000Z\",\"email_verified\":true,\"mobile_verified\":true,\"mobilekyc_verified\":true,\"bank_verified\":true,\"suspended\":false,\"address\":null,\"companies\":[{\"id\":\"9d2e5c8a-8765-4321-9abc-def012345678\",\"reference\":\"XYZ789\",\"name\":\"Acme Corp Pty Ltd\",\"abn\":\"53004085616\",\"kyb_verified\":true}]},\"reference\":\"order-8812\",\"authenticated_at\":\"2026-08-31T04:01:00.000000Z\"}}", "name": "Login code verified" }, { "header": [], "code": 404, "body": "{\"message\":\"Not Found\"}", "name": "The session does not exist for this partner" }, { "header": [], "code": 422, "body": "{\"message\":\"Invalid or expired login code.\"}", "name": "The code is wrong, expired, already redeemed, or the session is not authenticated" } ] } ] }, { "name": "Verification Codes", "description": "Send your users a one-time code by email or SMS for your own checks, such as confirming a login or a change of details, then check the code they give you. A verified code is only for your use: it does not verify the user's email or mobile in GoEscrow and does not approve any GoEscrow action. GoEscrow must enable verification codes for your account.", "item": [ { "name": "Send a verification code by email", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verification-codes\/email", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verification-codes\/email", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reference\":\"payout-change-981\",\"message\":{\"subject\":\"Confirm your new payout account\",\"body\":\"Use this code to confirm the new payout account on your CarHub profile.\"}}" }, "description": "Only users your account created can be sent codes. Codes are 6 digits, expire after 10 minutes, work once, and lock after 5 incorrect attempts. Sending again for the same user, channel and reference replaces the previous code. Up to 5 codes per user and channel every 10 minutes. Errors from these endpoints carry a stable code and a retryable flag, except invalid input (the standard validation response with errors per field) and the per-user send limit (the standard 429 response). The user needs a verified email address. Without a message, GoEscrow sends its standard verification email. With a message, your subject and body are used inside the GoEscrow email, which always shows the code and \"Sent on behalf of\" your name." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"channel\":\"email\",\"sent_to\":\"s***h@e*****e.com\",\"id\":\"7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f\",\"reference\":\"payout-change-981\",\"expires_at\":\"2026-10-16T10:40:00+10:00\"}}", "name": "Code sent" }, { "header": [], "code": 403, "body": "{\"message\":\"Verification codes are not enabled for this partner. Contact GoEscrow to turn them on.\",\"code\":\"verification_codes_not_enabled\",\"retryable\":false}", "name": "Verification codes are not enabled for your account" }, { "header": [], "code": 404, "body": "{\"message\":\"User not found or access denied.\",\"code\":\"user_not_found\",\"retryable\":false}", "name": "The user does not exist or was not created by your account" }, { "header": [], "code": 409, "body": "{\"message\":\"Another request for this code is in progress. Retry shortly.\",\"code\":\"verification_code_busy\",\"retryable\":true}", "name": "A send for the same user, channel and reference is in progress" }, { "header": [], "code": 422, "body": "{\"message\":\"The user has no verified email address.\",\"code\":\"email_not_verified\",\"retryable\":false}", "name": "No verified email address" }, { "header": [], "code": 422, "body": "{\"message\":\"The reference field is required.\",\"errors\":{\"reference\":[\"The reference field is required.\"]}}", "name": "Invalid input: the standard validation response, with errors per field" }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "More than 5 codes for this user in 10 minutes: the standard rate limit response" }, { "header": [], "code": 503, "body": "{\"message\":\"The code could not be sent. Retry shortly.\",\"code\":\"verification_code_send_failed\",\"retryable\":true}", "name": "Sending failed; the code was not issued" } ] }, { "name": "Send a verification code by SMS", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/:user_id\/verification-codes\/sms", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users\/:user_id\/verification-codes\/sms", "variable": [ { "id": "user_id", "key": "user_id", "value": "9d2e5c8a-1234-5678-9abc-def012345678", "description": "The user UUID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reference\":\"payout-change-981\",\"message\":\"Your code to confirm your new CarHub payout account is {code}.\"}" }, "description": "Only users your account created can be sent codes. Codes are 6 digits, expire after 10 minutes, work once, and lock after 5 incorrect attempts. Sending again for the same user, channel and reference replaces the previous code. Up to 5 codes per user and channel every 10 minutes. Errors from these endpoints carry a stable code and a retryable flag, except invalid input (the standard validation response with errors per field) and the per-user send limit (the standard 429 response). The user needs a verified mobile number. Without a message, the SMS reads \" via GoEscrow: Your verification code is 123456. It expires in 10 minutes. Never share it.\" With a message, it reads \" via GoEscrow: Never share this code.\" There is a daily limit on SMS codes per partner." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f\",\"channel\":\"sms\",\"reference\":\"payout-change-981\",\"sent_to\":\"+61******111\",\"expires_at\":\"2026-10-16T10:40:00+10:00\"}}", "name": "Code sent" }, { "header": [], "code": 403, "body": "{\"message\":\"Verification codes are not enabled for this partner. Contact GoEscrow to turn them on.\",\"code\":\"verification_codes_not_enabled\",\"retryable\":false}", "name": "Verification codes are not enabled for your account" }, { "header": [], "code": 404, "body": "{\"message\":\"User not found or access denied.\",\"code\":\"user_not_found\",\"retryable\":false}", "name": "The user does not exist or was not created by your account" }, { "header": [], "code": 409, "body": "{\"message\":\"Another request for this code is in progress. Retry shortly.\",\"code\":\"verification_code_busy\",\"retryable\":true}", "name": "A send for the same user, channel and reference is in progress" }, { "header": [], "code": 422, "body": "{\"message\":\"The user has no verified mobile number.\",\"code\":\"mobile_not_verified\",\"retryable\":false}", "name": "No verified mobile number" }, { "header": [], "code": 422, "body": "{\"message\":\"The reference field is required.\",\"errors\":{\"reference\":[\"The reference field is required.\"]}}", "name": "Invalid input: the standard validation response, with errors per field" }, { "header": [], "code": 429, "body": "{\"message\":\"This partner has reached its daily limit of SMS verification codes. Try again tomorrow or contact GoEscrow.\",\"code\":\"verification_code_daily_sms_limit\",\"retryable\":false}", "name": "Daily SMS limit reached" }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "More than 5 codes for this user in 10 minutes: the standard rate limit response" }, { "header": [], "code": 503, "body": "{\"message\":\"The code could not be sent. Retry shortly.\",\"code\":\"verification_code_send_failed\",\"retryable\":true}", "name": "Sending failed; the code was not issued" } ] }, { "name": "Check a verification code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/verification-codes\/:verification_code_id\/verify", "query": [], "raw": "{{baseUrl}}\/api\/v1\/verification-codes\/:verification_code_id\/verify", "variable": [ { "id": "verification_code_id", "key": "verification_code_id", "value": "7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f", "description": "The id returned when the code was sent" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"verification_code\":\"482913\"}" }, "description": "Checks the code your user gave you. A correct code is marked as used and cannot be checked again. Only the partner that sent a code can check it. Up to 30 checks a minute." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"verified\":true,\"id\":\"7c1d2e3f-4a5b-4c6d-8e9f-0a1b2c3d4e5f\",\"channel\":\"sms\",\"reference\":\"payout-change-981\",\"verified_at\":\"2026-10-16T10:32:00+10:00\"}}", "name": "Code correct" }, { "header": [], "code": 403, "body": "{\"message\":\"Verification codes are not enabled for this partner. Contact GoEscrow to turn them on.\",\"code\":\"verification_codes_not_enabled\",\"retryable\":false}", "name": "Verification codes are not enabled for your account" }, { "header": [], "code": 404, "body": "{\"message\":\"Verification code not found.\",\"code\":\"verification_code_not_found\",\"retryable\":false}", "name": "No code with this id was sent by your account" }, { "header": [], "code": 409, "body": "{\"message\":\"Another request for this code is in progress. Retry shortly.\",\"code\":\"verification_code_busy\",\"retryable\":true}", "name": "Another check of the same code is in progress" }, { "header": [], "code": 422, "body": "{\"message\":\"The verification code is incorrect.\",\"code\":\"verification_code_incorrect\",\"retryable\":false}", "name": "Codes: verification_code_incorrect, verification_code_locked (5 incorrect attempts), verification_code_expired, verification_code_used, verification_code_replaced (a newer code was sent for the reference)" }, { "header": [], "code": 422, "body": "{\"message\":\"The verification code field must be 6 digits.\",\"errors\":{\"verification_code\":[\"The verification code field must be 6 digits.\"]}}", "name": "Invalid input: the standard validation response, with errors per field" }, { "header": [], "code": 429, "body": "{\"message\":\"Too Many Attempts.\"}", "name": "More than 30 checks in a minute: the standard rate limit response" } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "key", "value": "X-API-Key", "type": "string" } ] } }