Update a payout

NodeJs

const { FedaPay, Payout } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Update a payout */
const payout = await Payout.update(params = {}, headers = {});

require 'fedapay';
# configure FedaPay library
FedaPay.api_key = '' # Your secret api key
FedaPay.environment = '' # sandbox or live
# Update a payout instance
payout.amount = 5000
payout.save
# Or
payout.save amount: 5000
# Update a payout by id
FedaPay.update ID, amount: 5000;

curl --request PUT \
  --url https://sandbox-api.fedapay.com/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": {
    "iso": "<string>"
  },
  "customer": {
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "jsmith@example.com"
  },
  "mode": "<string>"
}
'

import requests

url = "https://sandbox-api.fedapay.com/v1/payouts/{id}"

payload = {
    "amount": 123,
    "currency": { "iso": "<string>" },
    "customer": {
        "firstname": "<string>",
        "lastname": "<string>",
        "email": "jsmith@example.com"
    },
    "mode": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.fedapay.com/v1/payouts/{id}"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"currency\": {\n    \"iso\": \"<string>\"\n  },\n  \"customer\": {\n    \"firstname\": \"<string>\",\n    \"lastname\": \"<string>\",\n    \"email\": \"jsmith@example.com\"\n  },\n  \"mode\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox-api.fedapay.com/v1/payouts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"currency\": {\n    \"iso\": \"<string>\"\n  },\n  \"customer\": {\n    \"firstname\": \"<string>\",\n    \"lastname\": \"<string>\",\n    \"email\": \"jsmith@example.com\"\n  },\n  \"mode\": \"<string>\"\n}")
  .asString();

{
  "id": 123,
  "reference": "<string>",
  "amount": 123,
  "status": "<string>",
  "customer_id": 123,
  "currency_id": 123,
  "mode": "<string>",
  "last_error_code": "<string>",
  "commission": 123,
  "fees": 123,
  "fixed_commission": 123,
  "amount_transferred": 123,
  "amount_debited": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "custom_metadata": {},
  "payment_method_id": 123,
  "transaction_key": "<string>",
  "merchant_reference": "<string>",
  "account_id": 123,
  "balance_id": 123
}

PUT

payouts

{id}

NodeJs

const { FedaPay, Payout } = require('fedapay');
/* Replace YOUR_SECRETE_API_KEY with your real API key */
FedaPay.setApiKey("YOUR_SECRETE_API_KEY");
/* Specify whether you want to run your query in test or live mode */
FedaPay.setEnvironment('sandbox'); //or setEnvironment('live');
/* Update a payout */
const payout = await Payout.update(params = {}, headers = {});

require 'fedapay';
# configure FedaPay library
FedaPay.api_key = '' # Your secret api key
FedaPay.environment = '' # sandbox or live
# Update a payout instance
payout.amount = 5000
payout.save
# Or
payout.save amount: 5000
# Update a payout by id
FedaPay.update ID, amount: 5000;

curl --request PUT \
  --url https://sandbox-api.fedapay.com/v1/payouts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": {
    "iso": "<string>"
  },
  "customer": {
    "firstname": "<string>",
    "lastname": "<string>",
    "email": "jsmith@example.com"
  },
  "mode": "<string>"
}
'

import requests

url = "https://sandbox-api.fedapay.com/v1/payouts/{id}"

payload = {
    "amount": 123,
    "currency": { "iso": "<string>" },
    "customer": {
        "firstname": "<string>",
        "lastname": "<string>",
        "email": "jsmith@example.com"
    },
    "mode": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.fedapay.com/v1/payouts/{id}"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"currency\": {\n    \"iso\": \"<string>\"\n  },\n  \"customer\": {\n    \"firstname\": \"<string>\",\n    \"lastname\": \"<string>\",\n    \"email\": \"jsmith@example.com\"\n  },\n  \"mode\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://sandbox-api.fedapay.com/v1/payouts/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"currency\": {\n    \"iso\": \"<string>\"\n  },\n  \"customer\": {\n    \"firstname\": \"<string>\",\n    \"lastname\": \"<string>\",\n    \"email\": \"jsmith@example.com\"\n  },\n  \"mode\": \"<string>\"\n}")
  .asString();

{
  "id": 123,
  "reference": "<string>",
  "amount": 123,
  "status": "<string>",
  "customer_id": 123,
  "currency_id": 123,
  "mode": "<string>",
  "last_error_code": "<string>",
  "commission": 123,
  "fees": 123,
  "fixed_commission": 123,
  "amount_transferred": 123,
  "amount_debited": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "failed_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "metadata": {},
  "custom_metadata": {},
  "payment_method_id": 123,
  "transaction_key": "<string>",
  "merchant_reference": "<string>",
  "account_id": 123,
  "balance_id": 123
}

Autorisations

Authorization

string

header

requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

integer

requis

Payout ID.

Corps

application/json

amount

integer

requis

Amount of the payout.

currency

object

requis

Currency information.

Show child attributes

customer

object

requis

Customer information.

Show child attributes

mode

string

requis

Payout mode (e.g., 'bank_transfer', 'mobile_money').

Réponse

Payout updated successfully.

integer

Payout ID.

reference

string

Payout reference.

amount

integer

Payout amount.

status

string

Payout status (e.g., 'pending', 'scheduled', 'sent', 'failed').

customer_id

integer

Customer ID associated with the payout.

currency_id

integer

Currency ID associated with the payout.

mode

string

Payout mode.

last_error_code

string

Last error code encountered during the payout.

commission

integer

Payout commission.

fees

integer

Payout fees.

fixed_commission

integer

Fixed commission applied to the payout.

amount_transferred

integer

Amount transferred to the beneficiary.

amount_debited

integer

Amount debited from the payer.

created_at

string<date-time>

Date and time of payout creation.

updated_at

string<date-time>

Date and time of last payout update.

scheduled_at

string<date-time>

Date and time the payout is scheduled to be sent.

sent_at

string<date-time>

Date and time the payout was sent.

failed_at

string<date-time>

Date and time the payout failed.

deleted_at

string<date-time>

Date and time of payout deletion.

metadata

object

Additional metadata related to the payout.

custom_metadata

object

Custom metadata associated with the payout.

payment_method_id

integer

Payment method ID used for the payout.

transaction_key

string

Unique key associated with the payout.

merchant_reference

string

Merchant reference provided for the payout.

account_id

integer

Account ID associated with the payout.

balance_id

integer

Balance ID associated with the payout.

Introduction

Collects

Payouts

Events

Balances

Currencies

Logs

Webhooks

Update a payout

Autorisations

Paramètres de chemin

Corps

Réponse