Issue Payouts
Let's pretend we code for a music distributor, and we want to add Nerve as a payout option.
We'll post a display name of the creator we'd like to pay to create an account connection. Account Connections represent the relationship between your enterprise and a specific creator. It includes such details as the creator's name, how they've connected (Nerve or ACH), and what permissions they have granted you.
Create Account Connection
{
"first_name": "Paul",
"last_name": "McCartney",
"email": "[email protected]",
"requested_permissions": ["payment.credit"],
"verification_prompt": "What are the last 4 digits of your tax ID?",
"verification_answer": "1234"
}
We get a new account connection object in response.
Account Connection
{
"id": "acon_XXXXX",
"status": "created",
"first_name": "Paul",
"last_name": "McCartney",
"email": "[email protected]",
"requested_permissions": ["payment.credit"],
"verification_prompt": "Please enter the last 4 digits of your tax ID."
}
Note that Paul hasn't given us any permissions yet.
Paul just clicked the "Set Up Payments" button in our web app. We're going to send him through a short, Nerve-powered onboarding flow call Connect to activate his account connection. We'll create a "Connect Link" to securely launch a personalized flow from within Paul's authenticated session. Nerve handles the onboarding, then redirects Paul back to us once complete. We'll post the following to create a Connect Link for Paul:
Create Connect Link
{
"account_connection": "acon_XXXXX",
"return_url": "https://app.yoursite.com"
}
We get a new Connect Link back:
Connect Link
{
"url": "http://connect.nerve.pro/ZtT57HxTAaJwvgqjCadbSgoQPIBjJ3r7p0W8",
"created_at": "2022-02-02T20:39:01.015Z",
"expires_at": "2022-02-02T20:49:01.014Z"
}
The Connect Link expires 10 minutes after it's created. We immediately redirect Paul to that URL to complete the process.
Once Paul gets redirected back to us, we can refresh his account connection to see what changes he made. (We can also be notified via webhook.)
Nerve
ACH
Get Account Connection
{
"id": "acon_XXXXX",
"status": "active",
"type": "nerve",
"first_name": "Paul",
"last_name": "McCartney",
"email": "[email protected]",
"requested_permissions": ["payment.credit"],
"permissions": [
{"name": "payment.credit"}
],
"destination": "Nerve Account - Paul McCartney"
}
Great! Paul decided to open a Nerve account, or get paid to his existing Nerve account.
His account connection is now
active, and enabled for realtime payouts. We reflect that back to him, and use the destination label to make it crystal clear to him where his money will be going.
Get Account Connection
{
"id": "acon_XXXXX",
"status": "active",
"type": "ach",
"first_name": "Paul",
"last_name": "McCartney",
"email": "[email protected]",
"requested_permissions": ["payment.credit"],
"permissions": [
{"name": "payment.credit"}
],
"destination": "BANK OF AMERICA checking (*1234)"
}
Great! Paul decided to get paid to a different bank account, and has entered his ACH information.
His account connection is now
active, and enabled for ach payouts. We reflect that back to him, and use the destination label to make it crystal clear to him where his money will be going.
Create Payout
{
"account_connection": "acon_XXXXX",
"amount_in_cents": 1000,
"description": "January Payout"
}
The payout status will return with a
pending status immediately after creation:Payout
{
"id": "pay_XXXXX",
"type": "nerve",
"status": "pending",
"account_connection": "acon_XXXXX",
"destination": "Nerve Account - Paul McCartney",
"description": "January Payout",
"amount_in_cents": 1000,
"fee_in_cents": 10,
"created_at": "2022-02-02T22:45:00.668Z",
"updated_at": "2022-02-02T22:45:00.668Z"
}
Nerve payouts will change to a
sent status a few seconds after creation, and the money will be immediately available for Paul to spend.ACH payouts are
sent in a batch several times a day Monday through Friday (excluding bank holidays). ACH payments will be available for Paul in the next few business days (the receiving bank's policies are responsible for a majority of the variation with ACH timing). Learn more about ACH payments.Now that Paul is connected via Nerve, he can be paid again by simply creating new payouts.
Last modified 1yr ago