Create payout destination
Create a payout destination for an account
Dintero admins (access tokens with the admin:dintero scope) can replace Dintero’s standard terms for sellers with links to custom agreements by supplying custom_agreements. A case created with custom_agreements is always reviewed manually, it is never approved automatically.
scopes:
- admin:accounts
- write:accounts
- write:accounts:/management/settings/approvals
Authorizations
Path Parameters
An id that uniquely identifies the account or owner (partner)
Body
Payout destination details
40^[A-Za-z0-9_-]+$"PD032"
Reference on transfers in bank statements
Bank accounts associated with the payout destination.
1 - 2 elements- For a company seller select
companyor leave blank. Required fields areorganization_numberandcountry_code. - For an individual seller select
individual. Provide optional fields in the individual object.
company, individual day, week, month, manual ^\d{1,4}"2741"
Organization data for company type of payout destination
Used only if type is individual.
The name of the payout destination
60Description of the payout destination
For testing purposes it is possible to auto-approve, auto-decline, or keep a new seller waiting for signature by setting this field to one of the following values:
- "AUTO_APPROVE": Approves the case automatically, the case status will be set to
ACTIVE - "AUTO_DECLINE": Declines the case automatically, the case status will be set to
DECLINED - "AUTO_WAITING_FOR_SIGNATURE": Leaves the signature check for the case, the case status will be set to
WAITING_FOR_SIGNATURE
NOTE: This behavior is only available in test mode, i.e. with an oid prefixed with "T".
1000The user that will submit the form. If the email is set the user will be notified about the form via email.
See Seller onboarding - Reminder emails for the reminder schedule.
Links to agreements the seller has to accept, replacing Dintero's
standard terms for sellers. Requires an access token with the
admin:dintero scope, a request from a token without that scope is
rejected with 400.
An empty array creates a case without any terms, where the seller is not asked to accept anything.
A case created with custom_agreements is always reviewed manually, it is never approved automatically.
10Optional settings for automatically creating report configurations when the payout destination is created.
Response
Created AuthPayoutDestination resource
An UUID that uniquely identifies the resource
The date-time when the resource was created
The ID of the user/client created the resource
"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
The date-time when the resource was last updated
^[PT]{1}\d{8}$ACTIVE, DECLINED, UNDER_MANUAL_REVIEW, AUTOMATIC_REVIEW, WAITING_FOR_SIGNATURE, WAITING_FOR_DECLARATION, ERROR, ARCHIVED, WAITING_FOR_DETAILS, TERMINATED Type of legal entity
company, individual The ID of the user/client created the resource
"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"
40^[A-Za-z0-9_-]+$"PD032"
^\d{1,4}"2741"
Organization data for company type of payout destination
Used only if type is individual.
Bank accounts associated with the payout destination.
1 - 2 elementsday, week, month, manual Reference on transfers in bank statements
ITU/E.123 format with international prefix (+PPNNNNNNNNN...)
^\+?\d{5,15}$The name of the payout destination
Description of the payout destination
Type of platform for merchants using split payout.
marketplace, aggregator, reimburser Number of stores associated with the payout destination
Number of terminals associated with the payout destination
Terminals associated with the payout destination
Stores associated with the payout destination
The user that will submit the form. If the email is set the user will be notified about the form via email.
See Seller onboarding - Reminder emails for the reminder schedule.