charge_authorization: Charge Authorization

Description Usage Arguments Details

Description

Charge Authorization

Usage

1
charge_authorization(authorization, ...)

Arguments

authorization

set_keys("", "SECRET_KEY")$secret, equivalent of "-H Authorization: Bearer SECRET_kEY"

...

Body Params

amount

int32. REQUIRED Amount in kobo

authorization_code

string. REQUIRED Authorization code representing card you want charged

email

string. REQUIRED Customer's email address

plan

string. If transaction is to create a subscription to a predefined plan, provide plan code here.

quantity

float. Used to apply a multiple to the amount returned by the plan code above.

invoice_limit

int32. Number of invoices to raise during the subscription. Overrides invoice_limit set on plan.

currency

string. Currency in which amount should be charged

metadata

object. JSON object. Add a custom_fields attribute which has an array of objects if you would like the fields to be added to your transaction when displayed on the dashboard. Sample: "custom_fields":["display_name":"Cart ID","variable_name":"cart_id","value":"8393"]

subaccount

string. The code for the subaccount that owns the payment. e.g. ACCT_8f4s1eq7ml6rlzj

transaction_charge

int32. A flat fee to charge the subaccount for this transaction, in kobo. This overrides the split percentage set when the subaccount was created. Ideally, you will need to use this if you are splitting in flat rates (since subaccount creation only allows for percentage split). e.g. 7000 for a 70 naira flat fee.

bearer

string. Who bears Paystack charges? account or subaccount.

queue

boolean. If you are making a scheduled charge call, it is a good idea to queue them so the processing system does not get overloaded causing transaction processing errors. Send queue:true to take advantage of our queued charging.

Details

This will only work for authorizations with for which reusable is true


ebinabo/paystack documentation built on May 16, 2019, 8:16 p.m.