Modular Payouts - Error Scenarios

API error scenarios

EndpointHTTP StatusScenarioResponse
POST /payouts403Request carries no API key{"error": true, "message": "Missing API Key"}
POST /payouts403API key lacks the withdraw permissions required to post payouts{"error": true, "message": "This api key does not have the required withdraw permissions to post payouts."}
POST /payouts400Missing required body field{"errors": ["payor should have required property 'participant_code'"]}
POST /payouts400Missing required nested field (examples){"errors": ["payment should have required property 'asset'"]}
POST /payouts400Wrong field type{"errors": ["payment.total should be string"]}
POST /payouts400signed_timestamp not an integer{"errors": ["signed_timestamp should be integer"]}
POST /payouts400sanction_screening not in enum{"errors": ["sanction_screening should be equal to one of the allowed values"]}
POST /payouts400onboarding_profile not in allowed enum (UP entity){"errors": ["onboarding_profile should be equal to one of the allowed values"]}
POST /payouts400merchant_category_code not a 4-digit string{"errors": ["merchant_category_code should match pattern "^[0-9]{4}$""]}
POST /payouts400Unknown / extra field anywhere in body{"errors": ["should NOT have additional properties"]}
POST /payouts400validate flag wrong type{"errors": ["validate should be boolean"]}
POST /payouts400payor not exactly one of participant_code or info (both or neither){"errors": ["payor must specify exactly one of participant_code or info"]}
POST /payouts400beneficiary not exactly one of participant_code or info{"errors": ["beneficiary must specify exactly one of participant_code or info"]}
POST /payouts400beneficiary.info not exactly one of entity or individual{"errors": ["beneficiary.info must specify exactly one of entity or individual"]}
POST /payoutsexternal_account not exactly one of external_account_id or info
POST /payouts
POST /payouts
POST /payouts
POST /payouts
POST /payouts
POST /payouts
POST /payouts
POST /payouts
POST /payouts