This method allows you to perform an "authorize" operation (also called "preauthorization" or "authorization") through your payment gateway. When you perform the "authorize" operation, the bank that issued the credit card will place an authorization of the total amount of the funds. This is how the bank determines if the funds are available to make the purchase. The card will not actually be “charged” until you perform the "capture" operation (using our [PUT] /PaymentGateway/capture method).
Please note, different card brands and different banks allow for different time frames on the lifespan of a payment authorization. You will need to check with your payment processor on how long you would have between performing an "authorize" operation and a "charge" operation".
If needed, you can void this "authorize" operation by using the [DELETE] /PaymentGateway/void method
Additional parameters may be required
Please note that some payment processors require custom parameters and properties to be added to the request sent to them. We have outlined all of the payment processors that require additional information here.
Payment gateway merchant account credentials
Orchestra offers you two options of providing us with the merchant account credentials needed to send a charge request to the payment gateway:
- Provide the merchant account credentials inline in the request by supplying the
paymentGatewayAccountobject.- Use our Payment Gateway Account system to pre-upload and store the credentials in our system and then providing the reference name in the
paymentGatewayAccountNameparameter.