Skip to content

README.md

Latest commit

 

History

History
275 lines (206 loc) · 15.5 KB

README.md

File metadata and controls

275 lines (206 loc) · 15.5 KB

PaymentMethods

Overview

Available Operations

  • list - List all payment methods
  • create - Create payment method
  • get - Get payment method
  • delete - Delete payment method

list

List all stored payment method.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.ListPaymentMethodsRequest;
import com.gr4vy.sdk.models.operations.ListPaymentMethodsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ListPaymentMethodsRequest req = ListPaymentMethodsRequest.builder()
                .cursor("ZXhhbXBsZTE")
                .buyerId("fe26475d-ec3e-4884-9553-f7356683f7f9")
                .buyerExternalIdentifier("buyer-12345")
                .externalIdentifier("payment-method-12345")
                .build();


        sdk.paymentMethods().list()
                .callAsStream()
                .forEach((ListPaymentMethodsResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter Type Required Description
request ListPaymentMethodsRequest ✔️ The request object to use for the request.

Response

ListPaymentMethodsResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

create

Store a new payment method.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.components.CheckoutSessionPaymentMethodCreate;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.Body;
import com.gr4vy.sdk.models.operations.CreatePaymentMethodResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        CreatePaymentMethodResponse res = sdk.paymentMethods().create()
                .requestBody(Body.of(CheckoutSessionPaymentMethodCreate.builder()
                    .id("4137b1cf-39ac-42a8-bad6-1c680d5dab6b")
                    .build()))
                .call();

        if (res.paymentMethod().isPresent()) {
            System.out.println(res.paymentMethod().get());
        }
    }
}

Parameters

Parameter Type Required Description
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.
requestBody Body ✔️ N/A

Response

CreatePaymentMethodResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

get

Retrieve a payment method.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.GetPaymentMethodResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetPaymentMethodResponse res = sdk.paymentMethods().get()
                .paymentMethodId("ef9496d8-53a5-4aad-8ca2-00eb68334389")
                .call();

        if (res.paymentMethod().isPresent()) {
            System.out.println(res.paymentMethod().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
paymentMethodId String ✔️ The ID of the payment method ef9496d8-53a5-4aad-8ca2-00eb68334389
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.

Response

GetPaymentMethodResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*

delete

Delete a payment method.

Example Usage

package hello.world;

import com.gr4vy.sdk.Gr4vy;
import com.gr4vy.sdk.models.errors.*;
import com.gr4vy.sdk.models.operations.DeletePaymentMethodResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Gr4vy sdk = Gr4vy.builder()
                .merchantAccountId("default")
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        DeletePaymentMethodResponse res = sdk.paymentMethods().delete()
                .paymentMethodId("ef9496d8-53a5-4aad-8ca2-00eb68334389")
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description Example
paymentMethodId String ✔️ The ID of the payment method ef9496d8-53a5-4aad-8ca2-00eb68334389
merchantAccountId JsonNullable<String> ➖ The ID of the merchant account to use for this request.

Response

DeletePaymentMethodResponse

Errors

Error Type Status Code Content Type
models/errors/Error400 400 application/json
models/errors/Error401 401 application/json
models/errors/Error403 403 application/json
models/errors/Error404 404 application/json
models/errors/Error405 405 application/json
models/errors/Error409 409 application/json
models/errors/HTTPValidationError 422 application/json
models/errors/Error425 425 application/json
models/errors/Error429 429 application/json
models/errors/Error500 500 application/json
models/errors/Error502 502 application/json
models/errors/Error504 504 application/json
models/errors/APIException 4XX, 5XX */*